Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

doc/stdenv/stdenv.chapter.md: add information about nix-update-script and nixpkgs-update #249105

Merged
merged 1 commit into from
Aug 21, 2023

Conversation

NickHu
Copy link
Contributor

@NickHu NickHu commented Aug 14, 2023

Description of changes

We have some patterns in nixpkgs that ensure that our nix expressions are kept up to date, but these are not documented anywhere.

In particular, each package's passthru.updateScript attribute routinely gets run by @r-ryantm to automatically open PRs to update expressions in response to new versions of packages being released. We also have a top-level attribute nix-update-script which is a pretty effective default value for passthru.updateScript, but again this is not mentioned anywhere in the manual despite its frequent use across nixpkgs.

I'm not sure if I added enough detail, so feedback would be appreciated.

Closes #216321.

Things done

  • Built on platform(s)
    • x86_64-linux
    • aarch64-linux
    • x86_64-darwin
    • aarch64-darwin
  • For non-Linux: Is sandbox = true set in nix.conf? (See Nix manual)
  • Tested, as applicable:
  • Tested compilation of all packages that depend on this change using nix-shell -p nixpkgs-review --run "nixpkgs-review rev HEAD". Note: all changes have to be committed, also see nixpkgs-review usage
  • Tested basic functionality of all binary files (usually in ./result/bin/)
  • 23.11 Release Notes (or backporting 23.05 Release notes)
    • (Package updates) Added a release notes entry if the change is major or breaking
    • (Module updates) Added a release notes entry if the change is significant
    • (Module addition) Added a release notes entry if adding a new NixOS module
  • Fits CONTRIBUTING.md.

doc/stdenv/stdenv.chapter.md Outdated Show resolved Hide resolved
doc/stdenv/stdenv.chapter.md Outdated Show resolved Hide resolved
@NickHu NickHu requested a review from kjeremy August 15, 2023 09:14
@fricklerhandwerk fricklerhandwerk merged commit e9ad5bd into NixOS:master Aug 21, 2023
17 checks passed
@NickHu NickHu deleted the document-nix-update-script branch August 21, 2023 21:23
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Documentation: nix-update-script
4 participants