Nixpkgs/Automatic Updates: Difference between revisions
Add nix-update-script as alternate to unstableGitUpdater |
m Minor grammar/formatting |
||
| (12 intermediate revisions by 6 users not shown) | |||
| Line 1: | Line 1: | ||
[https://github.com/nix-community/nixpkgs-update nixpkgs-update] is used by [[r-ryantm]] for automated updates (through creating [https://github.com/NixOS/nixpkgs/issues?q=is%3Apr%20author%3Ar-ryantm update pull requests]).<br /> | |||
It uses package repository information from Repology.org (though that requires other projects to detect the update), the GitHub releases API, and, if available, the package <code>passthru.updateScript</code>. For more information, see the [https://nix-community.github.io/nixpkgs-update/ official documentation]. | |||
If you're wondering why your package isn't receiving automated updates, it can be useful to check the [https://r.ryantm.com/log/ r-ryantm logs]. | |||
== Disabling nixpkgs-update for individual packages == | |||
Put the following comment somewhere in the package file: | |||
<syntaxhighlight lang="nix"> | |||
# nixpkgs-update: no auto update | |||
</syntaxhighlight> | |||
== Update Scripts == | == Update Scripts == | ||
List of prepackaged update scripts | |||
Update Scripts can be added to packages by setting <code><nowiki>passthru.updateScript</nowiki></code>. This is then executed by [[r-ryantm]] to create an update pull request. It can be manually invoked via <code>nix-shell maintainers/scripts/update.nix --argstr package <packagename></code>. | |||
List of prepackaged update scripts: | |||
=== nix-update by Mic92 === | === nix-update by Mic92 === | ||
[https://github.com/Mic92/nix-update nix-update] works for a range of different sources and will do the right thing most of the time. | [https://github.com/Mic92/nix-update nix-update] works for a range of different sources and will do the right thing most of the time. | ||
| Line 19: | Line 34: | ||
=== Git Updater === | === Git Updater === | ||
Updates to the latest git tag. | Updates to the latest git tag. This updater only regenerates the source hash and is therefore unsuitable for package definitions with more than one FOD hash (e.g. Rust's <code>cargoHash</code>). | ||
<syntaxhighlight lang="nix"> | <syntaxhighlight lang="nix"> | ||
| Line 34: | Line 49: | ||
=== Unstable Git Updater === | === Unstable Git Updater === | ||
Updates to the latest git | Updates to the latest git commit. This updater only regenerates the source hash and is therefore unsuitable for package definitions with more than one FOD hash (e.g. Rust's <code>cargoHash</code>). | ||
<syntaxhighlight lang="nix"> | <syntaxhighlight lang="nix"> | ||
| Line 43: | Line 58: | ||
hardcodeZeroVersion = false; # Optional - Use a made-up version "0" instead of latest tag. Use when the project's tagging system is incompatible with what we expect from versions | hardcodeZeroVersion = false; # Optional - Use a made-up version "0" instead of latest tag. Use when the project's tagging system is incompatible with what we expect from versions | ||
tagFormat = "*"; # Optional - A `git describe --tags --match '<format>'` pattern that tags must match to be considered | tagFormat = "*"; # Optional - A `git describe --tags --match '<format>'` pattern that tags must match to be considered | ||
tagConverter = null; # Optional - command to convert more complex tag formats. It receives the git tag via stdin and should convert it into x.y.z format to stdout. Example: https://github.com/NixOS/nixpkgs/blob/ | tagConverter = null; # Optional - command to convert more complex tag formats. It receives the git tag via stdin and should convert it into x.y.z format to stdout. Example: https://github.com/NixOS/nixpkgs/blob/c0d71ad01729bf1acca3200ab418301ff2f9ee81/pkgs/by-name/ch/chirp/package.nix#L69-L73 | ||
shallowClone = true; # Optional - do not perform a complete clone | shallowClone = true; # Optional - do not perform a complete clone | ||
}; | }; | ||
</syntaxhighlight>Source: https://github.com/NixOS/nixpkgs/blob/master/pkgs/common-updater/unstable-updater.nix | </syntaxhighlight>Source: https://github.com/NixOS/nixpkgs/blob/master/pkgs/common-updater/unstable-updater.nix | ||
== Additional Resources == | |||
* [https://github.com/NixOS/nixpkgs/blob/master/pkgs/README.md#automatic-package-updates Contributing to nixpkgs - Automatic Package Updates (github.com/nixos/nixpkgs)] | * [https://github.com/NixOS/nixpkgs/blob/master/pkgs/README.md#automatic-package-updates Contributing to nixpkgs - Automatic Package Updates (github.com/nixos/nixpkgs)] | ||
* [https://nix-community.org/update-bot/ R. RyanTM nixpkgs-update bot information] | |||
[[Category:Nixpkgs]] | [[Category:Nixpkgs]] | ||