docs: add note on default envvar behaviour (#780)

python-semantic-release · Dec 22, 2023 · 0b07cae · 0b07cae
1 parent c1059f5
commit 0b07cae
Showing 1 changed file with 10 additions and 1 deletion.
diff --git a/docs/configuration.rst b/docs/configuration.rst
@@ -578,7 +578,16 @@ environment variable if you wish.
    configuring the environment variable for your remote VCS authentication token.
 
 
-**Default:** ``{ env = "GH_TOKEN" }``
+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" }``.
+
+
+**Default:** ``{ env = "<envvar name>" }``, where ``<envvar name>`` depends on
+:ref:`remote.type <config-remote-type>` as indicated above.
 
 
 .. _config-publish: