Incorrect documentation for git source
grawlinson opened this issue · 0 comments
grawlinson commented
nvchecker
fails to parse a config.toml file with layout as defined by the current git documentation:
$ cat config.toml
[plasma-pass-git]
source = "git"
url = "https://invent.kde.org/plasma/plasma-pass.git"
$ nvchecker -c config.toml
[E 10-06 10:32:08.550 core:330] plasma-pass-git: unexpected error happened error=KeyError('git')
Traceback (most recent call last):
File "/usr/lib/python3.8/site-packages/nvchecker/util.py", line 218, in run_one
version = await self.func(
File "/usr/lib/python3.8/site-packages/nvchecker_source/git.py", line 9, in get_version
git = conf['git']
KeyError: 'git'
The problem lies in the source parser for git, where it defines the remote repository using key=git
instead of key=url
.
There are two fixes available, either change the documentation to git
key or the code to url
key.
Thanks for nvchecker, by the way! It's an invaluable bit of software. 👍