Nixpkgs/Update Scripts: Difference between revisions
add info about nix-update, additional resources |
Add instructions for disabling nixpkgs-update |
||
| (5 intermediate revisions by 4 users not shown) | |||
| Line 3: | Line 3: | ||
== Update Scripts == | == Update Scripts == | ||
List of prepackaged update scripts. | List of prepackaged update scripts. | ||
=== 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. | |||
<syntaxhighlight lang="nix"> | |||
passthru.updateScript = nix-update-script { }; | |||
</syntaxhighlight> | |||
If you want functionality similar to that of unstableGitUpdater but with the additional handlers offered by nix-update, use: | |||
<syntaxhighlight lang="nix"> | |||
passthru.updateScript = nix-update-script { extraArgs = [ "--version=branch" ]; }; | |||
</syntaxhighlight> | |||
=== nixpkgs-update === | |||
[https://github.com/nix-community/nixpkgs-update nixpkgs-update] is used by [[r-ryantm]] for automated updates, if the package does not specify an <code>updateScript</code>. For more info, 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]. | |||
=== 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 20: | Line 39: | ||
=== 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 29: | Line 48: | ||
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 | ||
=== | === Disabling nixpkgs-update for individual packages === | ||
Put the following comment somewhere in the package file: | |||
<syntaxhighlight lang="nix"> | |||
# nixpkgs-update: no auto update | |||
</syntaxhighlight> | </syntaxhighlight> | ||