Skip to content

Commit

Permalink
docs(configuration): change defaults definition of token default to t…
Browse files Browse the repository at this point in the history
…able (#786)
  • Loading branch information
codejedi365 committed Jan 3, 2024
1 parent 758e649 commit df1df0d
Show file tree
Hide file tree
Showing 2 changed files with 13 additions and 9 deletions.
16 changes: 10 additions & 6 deletions docs/configuration.rst
Original file line number Diff line number Diff line change
Expand Up @@ -579,12 +579,16 @@ environment variable if you wish.
The default value for this setting depends on what you specify as
:ref:`remote.type <config-remote-type>`. If you set ``remote.type = "github"``,
the default value for ``remote.token`` will be ``{ env = "GH_TOKEN" }``;
if you set ``remote.type = "gitlab"``, the default value will be
``{ env = "GITLAB_TOKEN" }``; and if you set ``remote.type = "gitea"``, the
default value of ``remote.token`` will be ``{ env = "GITEA_TOKEN" }``.
:ref:`remote.type <config-remote-type>`. Review the table below to see what the
default token value will be for each remote type.
================ == ============================
``remote.type`` Default ``remote.token``
================ == ============================
``"github"`` -> ``{ env = "GH_TOKEN" }``
``"gitlab"`` -> ``{ env = "GITLAB_TOKEN" }``
``"gitea"`` -> ``{ env = "GITEA_TOKEN" }``
================ == ============================
**Default:** ``{ env = "<envvar name>" }``, where ``<envvar name>`` depends on
:ref:`remote.type <config-remote-type>` as indicated above.
Expand Down
6 changes: 3 additions & 3 deletions docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -129,11 +129,11 @@ usage. This token should be stored in the ``GH_TOKEN`` environment variable
To generate a token go to https://github.com/settings/tokens
and click on *Personal access token*.

GitLab (``GL_TOKEN``)
"""""""""""""""""""""
GitLab (``GITLAB_TOKEN``)
"""""""""""""""""""""""""

A personal access token from GitLab. This is used for authenticating when pushing
tags, publishing releases etc. This token should be stored in the ``GL_TOKEN``
tags, publishing releases etc. This token should be stored in the ``GITLAB_TOKEN``
environment variable.

Gitea (``GITEA_TOKEN``)
Expand Down

0 comments on commit df1df0d

Please sign in to comment.