1
1
mirror of https://github.com/nmattia/niv.git synced 2024-09-18 19:07:19 +03:00

Add --rev and -r

This should hopefully clarify that `--version` shouldn't be used for
GitHub repositories; moreover setting a particular revision is used much
more often than changing the repo name.
This commit is contained in:
Nicolas Mattia 2020-08-21 15:48:20 +02:00
parent de84001689
commit 89ae775e9d
3 changed files with 10 additions and 9 deletions

View File

@ -246,7 +246,7 @@ Examples:
Usage: niv add PACKAGE [-n|--name NAME] ([-a|--attribute KEY=VAL] |
[-s|--string-attribute KEY=VAL] | [-b|--branch BRANCH] |
[-o|--owner OWNER] | [-r|--repo REPO] | [-v|--version VERSION] |
[-o|--owner OWNER] | [-r|--rev REV] | [-v|--version VERSION] |
[-t|--template URL] | [-T|--type TYPE])
Add a GitHub dependency
@ -258,7 +258,7 @@ Available options:
Set the package spec attribute <KEY> to <VAL>.
-b,--branch BRANCH Equivalent to --attribute branch=<BRANCH>
-o,--owner OWNER Equivalent to --attribute owner=<OWNER>
-r,--repo REPO Equivalent to --attribute repo=<REPO>
-r,--rev REV Equivalent to --attribute rev=<REV>
-v,--version VERSION Equivalent to --attribute version=<VERSION>
-t,--template URL Used during 'update' when building URL. Occurrences
of <foo> are replaced with attribute 'foo'.
@ -284,8 +284,8 @@ Examples:
Usage: niv update [PACKAGE] ([-a|--attribute KEY=VAL] |
[-s|--string-attribute KEY=VAL] | [-b|--branch BRANCH] |
[-o|--owner OWNER] | [-r|--repo REPO] | [-v|--version VERSION]
| [-t|--template URL] | [-T|--type TYPE])
[-o|--owner OWNER] | [-r|--rev REV] | [-v|--version VERSION] |
[-t|--template URL] | [-T|--type TYPE])
Update dependencies
Available options:
@ -295,7 +295,7 @@ Available options:
Set the package spec attribute <KEY> to <VAL>.
-b,--branch BRANCH Equivalent to --attribute branch=<BRANCH>
-o,--owner OWNER Equivalent to --attribute owner=<OWNER>
-r,--repo REPO Equivalent to --attribute repo=<REPO>
-r,--rev REV Equivalent to --attribute rev=<REV>
-v,--version VERSION Equivalent to --attribute version=<VERSION>
-t,--template URL Used during 'update' when building URL. Occurrences
of <foo> are replaced with attribute 'foo'.
@ -315,8 +315,8 @@ Examples:
Usage: niv modify PACKAGE [-n|--name NAME] ([-a|--attribute KEY=VAL] |
[-s|--string-attribute KEY=VAL] | [-b|--branch BRANCH] |
[-o|--owner OWNER] | [-r|--repo REPO] | [-v|--version VERSION]
| [-t|--template URL] | [-T|--type TYPE])
[-o|--owner OWNER] | [-r|--rev REV] | [-v|--version VERSION] |
[-t|--template URL] | [-T|--type TYPE])
Modify dependency attributes without performing an update
Available options:
@ -327,7 +327,7 @@ Available options:
Set the package spec attribute <KEY> to <VAL>.
-b,--branch BRANCH Equivalent to --attribute branch=<BRANCH>
-o,--owner OWNER Equivalent to --attribute owner=<OWNER>
-r,--repo REPO Equivalent to --attribute repo=<REPO>
-r,--rev REV Equivalent to --attribute rev=<REV>
-v,--version VERSION Equivalent to --attribute version=<VERSION>
-t,--template URL Used during 'update' when building URL. Occurrences
of <foo> are replaced with attribute 'foo'.

View File

@ -6,6 +6,7 @@
#
# How To Release:
# * git checkout master
# * make sure changelog is up-to-date
# * bump version in package.yaml
# * run ./script/gen (twice...)
# * run ./script/test

View File

@ -97,7 +97,7 @@ parseGitHubPackageSpec =
shortcutAttributes =
foldr (<|>) empty $
mkShortcutAttribute
<$> ["branch", "owner", "repo", "version"]
<$> ["branch", "owner", "rev", "version"]
-- TODO: infer those shortcuts from 'Update' keys
mkShortcutAttribute :: T.Text -> Opts.Parser (T.Text, Aeson.Value)
mkShortcutAttribute = \case