Skip to content

Commit ea14933

Browse files
authored
Merge pull request #14139 from osbm/master
docs: Update documentation regarding the flake outputs
2 parents dc8c146 + 7f3f0f2 commit ea14933

File tree

1 file changed

+17
-7
lines changed

1 file changed

+17
-7
lines changed

src/nix/flake-check.md

Lines changed: 17 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -31,39 +31,49 @@ at the first error.
3131
The following flake output attributes must be derivations:
3232

3333
* `checks.`*system*`.`*name*
34-
* `defaultPackage.`*system*
35-
* `devShell.`*system*
34+
* `devShells.`*system*`.default`
3635
* `devShells.`*system*`.`*name*
3736
* `nixosConfigurations.`*name*`.config.system.build.toplevel`
37+
* `packages.`*system*`.default`
3838
* `packages.`*system*`.`*name*
3939

4040
The following flake output attributes must be [app
4141
definitions](./nix3-run.md):
4242

43+
* `apps.`*system*`.default`
4344
* `apps.`*system*`.`*name*
44-
* `defaultApp.`*system*
4545

4646
The following flake output attributes must be [template
4747
definitions](./nix3-flake-init.md):
4848

49-
* `defaultTemplate`
49+
* `templates.default`
5050
* `templates.`*name*
5151

5252
The following flake output attributes must be *Nixpkgs overlays*:
5353

54-
* `overlay`
54+
* `overlays.default`
5555
* `overlays.`*name*
5656

5757
The following flake output attributes must be *NixOS modules*:
5858

59-
* `nixosModule`
59+
* `nixosModules.default`
6060
* `nixosModules.`*name*
6161

6262
The following flake output attributes must be
6363
[bundlers](./nix3-bundle.md):
6464

65+
* `bundlers.default`
6566
* `bundlers.`*name*
66-
* `defaultBundler`
67+
68+
Old default attributes are renamed, they will work but will emit a warning:
69+
70+
* `defaultPackage.<system>``packages.`*system*`.default`
71+
* `defaultApps.<system>``apps.`*system*`.default`
72+
* `defaultTemplate``templates.default`
73+
* `defaultBundler.<system>``bundlers.`*system*`.default`
74+
* `overlay``overlays.default`
75+
* `devShell.<system>``devShells.`*system*`.default`
76+
* `nixosModule``nixosModules.default`
6777

6878
In addition, the `hydraJobs` output is evaluated in the same way as
6979
Hydra's `hydra-eval-jobs` (i.e. as a arbitrarily deeply nested

0 commit comments

Comments
 (0)