Nixpkgs/Update Scripts: Difference between revisions

Revision as of 23:03, 17 April 2024

Update Scripts can be added to packages via setting, passthru.updateScript which is then executed by r-ryantm to create an updated pull request or can be manually invoked via nix-shell maintainers/scripts/update.nix.

Update Scripts

List of prepackaged update scripts.

Git Updater

Updates to the latest git tag

passthru.updateScript = gitUpdater {
  ignoredVersions = ""; # Optional Filter to ignore versions
  rev-prefix = "v"; # Optional set if tags have a prefix before the version number
  odd-unstable = false; # Optional Ignore odd numberd versions
  patchlevel-unstable = false; # Optional Ignore patchlevel versions
  url = null; #  Optional Set this to a git url when the src is not a git repo
};

Unstable Git Updater

Updates to the latest git tag

passthru.updateScript = unstableGitUpdater {
  branch = null; # Optional Which branch should be updated from
  url = null; #  Optional Set this to a git url when the src is not a git repo
};

@@ Line 11: / Line 11: @@
 <syntaxhighlight lang="nix">
 passthru.updateScript = gitUpdater {
-   ignoredVersions = ""; # Optinal Filter to ignore versions
+   ignoredVersions = ""; # Optional Filter to ignore versions
-   rev-prefix = "v"; # Optinal set if tags have a prefix before the version number
+   rev-prefix = "v"; # Optional set if tags have a prefix before the version number
-   odd-unstable = false; # Optinal Ignore odd numberd versions
+   odd-unstable = false; # Optional Ignore odd numberd versions
-   patchlevel-unstable = false; # Optinal Ignore patchlevel versions
+   patchlevel-unstable = false; # Optional Ignore patchlevel versions
-   url = null; #  Optinal Set this to a git url when the src is not a git repo
+   url = null; #  Optional Set this to a git url when the src is not a git repo
 };
 </syntaxhighlight>
@@ Line 25: / Line 25: @@
 <syntaxhighlight lang="nix">
 passthru.updateScript = unstableGitUpdater {
-   branch = null; # Optinal Which branch should be updated from
+   branch = null; # Optional Which branch should be updated from
-   url = null; #  Optinal Set this to a git url when the src is not a git repo
+   url = null; #  Optional Set this to a git url when the src is not a git repo
 };
 </syntaxhighlight>
 [[Category:Nixpkgs]]