diff options
Diffstat (limited to 'pkgs/common-updater/unstable-updater.nix')
| -rw-r--r-- | pkgs/common-updater/unstable-updater.nix | 6 |
1 files changed, 5 insertions, 1 deletions
diff --git a/pkgs/common-updater/unstable-updater.nix b/pkgs/common-updater/unstable-updater.nix index d982fc6110ba7..e6981f633534b 100644 --- a/pkgs/common-updater/unstable-updater.nix +++ b/pkgs/common-updater/unstable-updater.nix @@ -8,9 +8,13 @@ # This is an updater for unstable packages that should always use the latest # commit. +# To use this updater, add the following to your package set: +# passthru.updateScript = unstableGitUpdater { }; +# relevant attributes can be passed as below: + { url ? null # The git url, if empty it will be set to src.gitRepoUrl , branch ? null -, hardcodeZeroVersion ? false # Use a made-up version "0" instead of latest tag. Use when there is no previous release, or the project's tagging system is incompatible with what we expect from versions +, hardcodeZeroVersion ? false # 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 ? "*" # A `git describe --tags --match '<format>'` pattern that tags must match to be considered , tagPrefix ? null # strip this prefix from a tag name , tagConverter ? null # A 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 |