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

docs: document changes don't mention the old keys

Browse source 
while the old way of declaring the keys is still available it is no longer documented

this should encourage new users to use the new, netrc-compatible way
This commit is contained in:
David Arnold 2024-03-02 10:48:59 +01:00
parent 8c82c3c289
commit f8a73a5a92
No known key found for this signature in database
GPG key ID: AB15A6AF1101390D
1 changed files with 9 additions and 3 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

12
docs/usage.rst
View file

@ -375,6 +375,9 @@ branch
path
Only commits containing this file path will be returned.
host
Hostname for self-hosted GitHub instance.
use_latest_release
Set this to ``true`` to check for the latest release on GitHub.
@ -415,8 +418,9 @@ An authorization token may be needed in order to use ``use_latest_tag``,
To set an authorization token, you can set:
- a key named ``github`` in the keyfile
- the token option
- an entry in the keyfile for the host (e.g. ``github.com``)
- an entry in your ``netrc`` file for the host
This source supports :ref:`list options` when ``use_max_tag`` is set.
@ -447,8 +451,9 @@ token
To set an authorization token, you can set:
- a key named ``gitea_{host}`` in the keyfile, where ``host`` is all-lowercased host name
- the token option
- an entry in the keyfile for the host (e.g. ``gitea.com``)
- an entry in your ``netrc`` file for the host
This source supports :ref:`list options` when ``use_max_tag`` is set.
@ -520,8 +525,9 @@ token
To set an authorization token, you can set:
- a key named ``gitlab_{host}`` in the keyfile, where ``host`` is all-lowercased host name
- the token option
- an entry in the keyfile for the host (e.g. ``gitlab.com``)
- an entry in your ``netrc`` file for the host
This source supports :ref:`list options` when ``use_max_tag`` is set.