unstableGitUpdater: document actual use procedure

This commit is contained in:
John Titor 2024-05-11 18:27:38 +05:30
parent f4c64495c4
commit 14676392cd
No known key found for this signature in database
GPG Key ID: 29B0514F4E3C1CC0

View File

@ -8,6 +8,10 @@
# 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