nixpkgs-manual: use injected revision only #330915
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
`lib.trivial.revisionWithDefault` will change with every Git commit, which causes the manual to be rebuilt on every since PR. Using `nixpkgs.rev` (or the dummy value "master" if it's not present) means that the manual will contain the revision if built on Hydra, but will not otherwise. Why? 1. https://hydra.nixos.org/jobset/nixos/trunk-combined#tabs-configuration shows that `pkgs/top-level/release.nix` is passed the `nixpkgs` attrset, which is a "Git checkout". 2. Git checkouts come from [`builtins.fetchGit`](https://nix.dev/manual/nix/2.18/language/builtins#builtins-fetchGit) and include the `rev` attribute. 3. The `rev` attribute is what `lib.trivial.revisionWithDefault` would have returned. So, using `nixpkgs.rev or "master"` exclusively will cause the rebuilds on every commit to cease, but will allow "official" nixpkgs manual built on Hydra to continue to reference a specific commit.
github-actions
bot
added
the
8.has: documentation
philiptaron
requested review from
emilazy,
a team,
Aleksanaa,
Artturin and
infinisil
ofborg
bot
added
10.rebuild-darwin: 0
Aleksanaa
approved these changes
Jul 30, 2024
SuperSandro2000
approved these changes
Jul 30, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Motivation for change
nixpkgs-manualis listed as a rebuild on every single PR since I introduced it to the top-level packages in #311459.Description of change
The existing derivation used
lib.trivial.revisionWithDefaultin its build phase. Due to that, the derivation will change with every Git commit, which then causes the manual to be rebuilt on every single PR or commit.Using
nixpkgs.rev(or the dummy value "master" if it's not present) means that the manual will contain the revision if built on Hydra, but will not otherwise.Why?
pkgs/top-level/release.nixis passed thenixpkgsattrset, which is a "Git checkout".builtins.fetchGitand include therevattribute.revattribute is whatlib.trivial.revisionWithDefaultwould have returned.So, using
nixpkgs.rev or "master"exclusively will cause the rebuilds on every commit to cease, but will allow "official" nixpkgs manual built on Hydra to continue to reference a specific commit.The line this PR replaces was introduced in be4d19f by @pennae (#239636).
nixpkgs/doc/default.nix
Line 80 in be4d19f
Things done