History

Alyssa Ross 7d40fbbc04 nix-prefetch-git: ignore global and user git config nix-prefetch-git is either run as part of a build, usually sandboxed, or outside a build, unsandboxed, to prefetch something that will later be used in a build. It's important that the latter use produces hashes that can be reproduced by the former. One way that they can differ is if the user's git config does something that changes the result of git clone. I ran into this, because my global git config automatically enables git-lfs, whereas nix-prefetch-git otherwise only uses git-lfs if specifically requested. This led to very confusing hash mismatches.		2023-09-22 06:59:40 +00:00
..
doc/manual	nix-prefetch-git: ignore global and user git config	2023-09-22 06:59:40 +00:00
lib	Merge pull request #192593 from jlesquembre/test-driver	2023-09-21 00:47:45 +03:00
maintainers	nixos/lxd: add virtual-machine support, image and module	2023-09-03 20:06:44 -04:00
modules	nixos/prometheus: fix blackbox exporter	2023-09-21 08:49:10 +02:00
tests	Merge pull request #252001 from imincik/qgis-nixos-test	2023-09-20 23:46:57 +04:00
COPYING
default.nix
README.md	CONTRIBUTING.md: Move boot loader-specific sentence to pkgs/README.md	2023-08-14 19:50:02 +02:00
release-combined.nix	nixos/release-combined.nix: Build pkgs/by-name tester	2023-08-29 16:35:07 +02:00
release-small.nix
release.nix	Merge pull request #244093 from adamcstephens/lxd/vm	2023-09-03 22:02:54 -05:00

README.md

NixOS

NixOS is a Linux distribution based on the purely functional package management system Nix. More information can be found at https://nixos.org/nixos and in the manual in doc/manual.

Testing changes

You can add new module to your NixOS configuration file (usually it’s /etc/nixos/configuration.nix). And do sudo nixos-rebuild test -I nixpkgs=<path to your local nixpkgs folder> --fast.

Reviewing contributions

When changing the bootloader installation process, extra care must be taken. Grub installations cannot be rolled back, hence changes may break people’s installations forever. For any non-trivial change to the bootloader please file a PR asking for review, especially from @edolstra.

Module updates

Module updates are submissions changing modules in some ways. These often contains changes to the options or introduce new options.

Reviewing process:

Ensure that the module maintainers are notified.
- CODEOWNERS will make GitHub notify users based on the submitted changes, but it can happen that it misses some of the package maintainers.
Ensure that the module tests, if any, are succeeding.
Ensure that the introduced options are correct.
- Type should be appropriate (string related types differs in their merging capabilities, loaOf and string types are deprecated).
- Description, default and example should be provided.
Ensure that option changes are backward compatible.
- mkRenamedOptionModuleWith provides a way to make option changes backward compatible.
Ensure that removed options are declared with mkRemovedOptionModule
Ensure that changes that are not backward compatible are mentioned in release notes.
Ensure that documentations affected by the change is updated.

Sample template for a module update review is provided below.

##### Reviewed points

- [ ] changes are backward compatible
- [ ] removed options are declared with `mkRemovedOptionModule`
- [ ] changes that are not backward compatible are documented in release notes
- [ ] module tests succeed on ARCHITECTURE
- [ ] options types are appropriate
- [ ] options description is set
- [ ] options example is provided
- [ ] documentation affected by the changes is updated

##### Possible improvements

##### Comments

New modules

New modules submissions introduce a new module to NixOS.