BioArchLinux/nvchecker
2
0
Fork 0
mirror of https://github.com/lilydjwg/nvchecker.git synced 2025-03-10 06:14:02 +00:00
Code Issues Projects Releases Packages Wiki Activity

make it clearer that github releases are not those tags

Browse source 
closes #123.
This commit is contained in:
lilydjwg 2019-12-09 12:50:55 +08:00
parent 9c9e7f89d9
commit fe2ff0aa74
1 changed files with 9 additions and 4 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

13
README.rst
View file

@ -287,10 +287,15 @@ path
Only commits containing this file path will be returned. Only commits containing this file path will be returned.
use_latest_release use_latest_release
Set this to ``true`` to check for the latest release on GitHub. An annotated Set this to ``true`` to check for the latest release on GitHub.
tag creates a "release" on GitHub. It's not the same with git tags, which
includes both annotated tags and lightweight ones. Will return the release name GitHub releases are not the same with git tags. You'll see big version names
instead of date. and descriptions in the release page for such releases, e.g.
`zfsonlinux/zfs's <https://github.com/zfsonlinux/zfs/releases>`_, and those
small ones like `nvchecker's <https://github.com/lilydjwg/nvchecker/releases>`_
are only git tags that should use ``use_max_tag`` below.
Will return the release name instead of date.
use_max_tag use_max_tag
Set this to ``true`` to check for the max tag on GitHub. Unlike Set this to ``true`` to check for the max tag on GitHub. Unlike