Nixpkgs/Automatic Updates: Difference between revisions

(4 intermediate revisions by 3 users not shown)

Line 1:

Update Scripts can be added to packages ~~via~~ setting, <code><nowiki>passthru.updateScript</nowiki></code> ~~which~~ is then executed by [[r-ryantm]] to create an updated pull request or can be manually invoked via <code>nix-shell maintainers/scripts/update.nix --argstr package <packagename></code>.

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 updated pull request. It can be manually invoked via <code>nix-shell maintainers/scripts/update.nix --argstr package <packagename></code>.

== Update Scripts ==

Line 15:

passthru.updateScript = nix-update-script { extraArgs = [ "--version=branch" ]; };

</syntaxhighlight>~~If you're wondering why your package isn't receiving update PRs, it can be useful to check the [https://r.ryantm.com/log/ ryantm logs].~~

</syntaxhighlight>

=== 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>).

Line 34:

=== Unstable Git Updater ===

Updates to the latest git ~~tag~~

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>).

Line 48:

</syntaxhighlight>Source: https://github.com/NixOS/nixpkgs/blob/master/pkgs/common-updater/unstable-updater.nix

=== Additional Resources ===

== Automatic updates with r-ryantm ==

=== 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].

=== Disabling nixpkgs-update for individual packages ===

Put the following comment somewhere in the package file:

# nixpkgs-update: no auto update

</syntaxhighlight>

== 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)]

[[Category:Nixpkgs]]

@@ Line 1: / Line 1: @@
-Update Scripts can be added to packages via setting, <code><nowiki>passthru.updateScript</nowiki></code> which is then executed by [[r-ryantm]] to create an updated pull request or can be manually invoked via <code>nix-shell maintainers/scripts/update.nix --argstr package <packagename></code>.
+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 updated pull request. It can be manually invoked via <code>nix-shell maintainers/scripts/update.nix --argstr package <packagename></code>.
 == Update Scripts ==
@@ Line 15: / Line 15: @@
 <syntaxhighlight lang="nix">
 passthru.updateScript = nix-update-script { extraArgs = [ "--version=branch" ]; };
-</syntaxhighlight>If you're wondering why your package isn't receiving update PRs, it can be useful to check the [https://r.ryantm.com/log/ ryantm logs].
+</syntaxhighlight>
 === 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">
@@ Line 34: / Line 34: @@
 === Unstable Git Updater ===
-Updates to the latest git tag
+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">
@@ Line 48: / Line 48: @@
 </syntaxhighlight>Source: https://github.com/NixOS/nixpkgs/blob/master/pkgs/common-updater/unstable-updater.nix
-=== Additional Resources ===
+== Automatic updates with r-ryantm ==
+=== 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].
+=== Disabling nixpkgs-update for individual packages ===
+Put the following comment somewhere in the package file:
+<syntaxhighlight lang="nix">
+# nixpkgs-update: no auto update
+</syntaxhighlight>
+== 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)]
 [[Category:Nixpkgs]]