.. _config:

Configuration
=============

Configuration is read from a file which can be specified using the
:ref:`\\\\-\\\\-config <cmd-main-option-config>` option to :ref:`cmd-main`. Python Semantic
Release currently supports a configuration in either TOML or JSON format, and will
attempt to auto-detect and parse either format.

When using a JSON-format configuration file, Python Semantic Release looks for its
settings beneath a top-level ``semantic_release`` key; when using a TOML-format
configuration file, Python Semantic Release first checks for its configuration under
the table ``[tool.semantic_release]`` (in line with the convention for Python tools to
require their configuration under the top-level ``tool`` table in their
``pyproject.toml`` file), followed by ``[semantic_release]``, which may be more desirable
if using a file other than the default ``pyproject.toml`` for configuration.

The examples on this page are given in TOML format, however there is no limitation on
using JSON instead. In fact, if you would like to convert any example below to its
JSON equivalent, the following commands will do this for you (in Bash):

.. code-block:: bash

    export TEXT="<the TOML to convert>"

    cat <<EOF | python3
    import tomlkit, json
    print(json.dumps(tomlkit.loads('''$TEXT'''), indent=4))
    EOF



A note on null
--------------

In TOML, there is no such thing as a "null" or "nil" value, and this isn't planned
as a language feature according to the relevant `GitHub issue`_.
In Python Semantic Release, options which default to ``None`` are inferred from the
relevant configuration settings not being present at all in your configuration.
Because of this limitation, it's currently not possible to *explicitly* specify those
settings as "null" in TOML-format configuration. Technically it is possible in
JSON-format configuration, but it's recommended to keep consistency and just omit
the relevant settings.

.. _`GitHub issue`: https://github.com/toml-lang/toml/issues/30

.. _config-environment-variables:

Environment Variables
---------------------

Some settings are best pulled from environment variables rather than being stored
in plaintext in your configuration file. Python Semantic Release can be configured
to look for an environment variable value to use for a given setting, but this feature
is not available for all settings. In order to use an environment variable for a setting,
you must indicate in your configuration file the name of the environment variable to use.

The traditional and most common use case for environment variable use is for passing
authentication tokens to Python Semantic Release. You do **NOT** want to hard code your
authentication token in your configuration file, as this is a **security risk**. A plaintext
token in your configuration file could be exposed to anyone with access to your repository,
including long after its deleted if a token is in your git history. Instead, define the name
of the environment variable which contains your :ref:`remote.token <config-remote-token>`,
such as ``GH_TOKEN``, in your configuration file, and Python Semantic Release will do the
rest, as seen below.

.. code-block:: toml

    [semantic_release.remote.token]
    env = "GH_TOKEN"

Given basic TOML syntax compatibility, this is equivalent to:

.. code-block:: toml

    [semantic_release.remote]
    token = { env = "GH_TOKEN" }

The general format for specifying that some configuration should be sourced from an
environment variable is:

.. code-block:: toml

    [semantic_release.variable]
    env = "ENV_VAR"
    default_env = "FALLBACK_ENV_VAR"
    default = "default value"

In this structure:

  * ``env`` represents the environment variable that Python Semantic Release will search for

  * ``default_env`` is a fallback environment variable to read in case the variable specified
    by ``env`` is not set. This is optional - if not specified then no fallback will be used.

  * ``default`` is a default value to use in case the environment variable specified by ``env``
    is not set. This is optional - if ``default`` is not specified then the environment variable
    specified by ``env`` is considered required.

.. _config-root:

``semantic_release`` settings
-----------------------------

The following sections outline all the definitions and descriptions of each supported
configuration setting. If there are type mis-matches, PSR will throw validation errors upon load.
If a setting is not provided, than PSR will fill in the value with the default value.

Python Semantic Release expects a root level key to start the configuration definition. Make
sure to use the correct root key depending on the configuration format you are using.

.. note:: If you are using ``pyproject.toml``, this heading should include the ``tool`` prefix
          as specified within PEP 517, resulting in ``[tool.semantic_release]``.

.. note:: If you are using a ``releaserc.toml``, use ``[semantic_release]`` as the root key

.. note:: If you are using a ``releaserc.json``, ``semantic_release`` must be the root key in the
          top level dictionary.

----

.. _config-add_partial_tags:

``add_partial_tags``
""""""""""""""""""""

**Type:** ``bool``

Specify if partial version tags should be handled when creating a new version. If set to
``true``, a ``major`` and a ``major.minor`` tag will be created or updated, using the format
specified in :ref:`tag_format`. If version has build metadata, a ``major.minor.patch`` tag
will also be created or updated.

Partial version tags are **disabled** for pre-release versions.

**Example**

.. code-block:: toml

    [semantic_release]
    tag_format = "v{version}"
    add_partial_tags = true

This configuration with the next version of ``1.2.3`` will result in:

.. code-block:: bash

    git log --decorate --oneline --graph --all
    # * 4d4cb0a (tag: v1.2.3, tag: v1.2, tag: v1, origin/main, main) 1.2.3
    # * 3a2b1c0 fix: some bug
    # * 2b1c0a9 (tag: v1.2.2) 1.2.2
    # ...

If build-metadata is used, the next version of ``1.2.3+20251109`` will result in:

.. code-block:: bash

    git log --decorate --oneline --graph --all
    # * 4d4cb0a (tag: v1.2.3+20251109, tag: v1.2.3, tag: v1.2, tag: v1, origin/main, main) 1.2.3+20251109
    # * 3a2b1c0 chore: add partial tags to PSR configuration
    # * 2b1c0a9 (tag: v1.2.3+20251031) 1.2.3+20251031
    # ...

**Default:** ``false``

----

.. _config-allow_zero_version:

``allow_zero_version``
""""""""""""""""""""""

*Introduced in v9.2.0*

**Type:** ``bool``

This flag controls whether or not Python Semantic Release will use version
numbers aligning with the ``0.x.x`` pattern.

If set to ``true`` and starting at ``0.0.0``, a minor bump would set the
next version as ``0.1.0`` whereas a patch bump would set the next version as
``0.0.1``. A breaking change (ie. major bump) would set the next version as
``1.0.0`` unless the :ref:`config-major_on_zero` is set to ``false``.

If set to ``false``, Python Semantic Release will consider the first possible
version to be ``1.0.0``, regardless of patch, minor, or major change level.
Additionally, when ``allow_zero_version`` is set to ``false``,
the :ref:`config-major_on_zero` setting is ignored.

*Default changed to ``false`` in v10.0.0*

**Default:** ``false``

----

.. _config-assets:

``assets``
""""""""""

**Type:** ``list[str]``

One or more paths to additional assets that should committed to the remote repository
in addition to any files modified by writing the new version.

**Default:** ``[]``

----

.. _config-branches:

``branches``
""""""""""""

This setting is discussed in more detail at :ref:`multibranch-releases`

**Default:**

.. code-block:: toml

    [semantic_release.branches.main]
    match = "(main|master)"
    prerelease_token = "rc"
    prerelease = false

----

.. _config-build_command:

``build_command``
"""""""""""""""""

**Type:** ``Optional[str]``

Command to use to build the current project during :ref:`cmd-version`.

Python Semantic Release will execute the build command in the OS default
shell with a subset of environment variables. PSR provides the variable
``NEW_VERSION`` in the environment with the value of the next determined
version. The following table summarizes all the environment variables that
are passed on to the ``build_command`` runtime if they exist in the parent
process.

If you would like to pass additional environment variables to your build
command, see :ref:`config-build_command_env`.

========================  ======================================================================
Variable Name             Description
========================  ======================================================================
CI                        Pass-through ``true`` if exists in process env, unset otherwise
BITBUCKET_CI              ``true`` if Bitbucket CI variables exist in env, unset otherwise
GITHUB_ACTIONS            Pass-through ``true`` if exists in process env, unset otherwise
GITEA_ACTIONS             Pass-through ``true`` if exists in process env, unset otherwise
GITLAB_CI                 Pass-through ``true`` if exists in process env, unset otherwise
HOME                      Pass-through ``HOME`` of parent process
NEW_VERSION               Semantically determined next version (ex. ``1.2.3``)
PATH                      Pass-through ``PATH`` of parent process
PACKAGE_NAME              Project name as defined in ``pyproject.toml:project.name``
PSR_DOCKER_GITHUB_ACTION  Pass-through ``true`` if exists in process env, unset otherwise
VIRTUAL_ENV               Pass-through ``VIRTUAL_ENV`` if exists in process env, unset otherwise
========================  ======================================================================

In addition, on windows systems these environment variables are passed:

========================  ======================================================================
Variable Name             Description
========================  ======================================================================
ALLUSERSAPPDATA           Pass-through ``ALLUSERAPPDATA`` if exists in process env, unset otherwise
ALLUSERSPROFILE           Pass-through ``ALLUSERSPPPROFILE`` if exists in process env, unset otherwise
APPDATA                   Pass-through ``APPDATA`` if exists in process env, unset otherwise
COMMONPROGRAMFILES        Pass-through ``COMMONPROGRAMFILES`` if exists in process env, unset otherwise
COMMONPROGRAMFILES(X86)   Pass-through ``COMMONPROGRAMFILES(X86)`` if exists in process env, unset otherwise
DEFAULTUSERPROFILE        Pass-through ``DEFAULTUSERPROFILE`` if exists in process env, unset otherwise
HOMEPATH                  Pass-through ``HOMEPATH`` if exists in process env, unset otherwise
PATHEXT                   Pass-through ``PATHEXT`` if exists in process env, unset otherwise
PROFILESFOLDER            Pass-through ``PROFILESFOLDER`` if exists in process env, unset otherwise
PROGRAMFILES              Pass-through ``PROGRAMFILES`` if exists in process env, unset otherwise
PROGRAMFILES(X86)         Pass-through ``PROGRAMFILES(X86)`` if exists in process env, unset otherwise
SYSTEM                    Pass-through ``SYSTEM`` if exists in process env, unset otherwise
SYSTEM16                  Pass-through ``SYSTEM16`` if exists in process env, unset otherwise
SYSTEM32                  Pass-through ``SYSTEM32`` if exists in process env, unset otherwise
SYSTEMDRIVE               Pass-through ``SYSTEMDRIVE`` if exists in process env, unset otherwise
SYSTEMROOT                Pass-through ``SYSTEMROOT`` if exists in process env, unset otherwise
TEMP                      Pass-through ``TEMP`` if exists in process env, unset otherwise
TMP                       Pass-through ``TMP`` if exists in process env, unset otherwise
USERPROFILE               Pass-through ``USERPROFILE`` if exists in process env, unset otherwise
USERSID                   Pass-through ``USERSID`` if exists in process env, unset otherwise
WINDIR                    Pass-through ``WINDIR`` if exists in process env, unset otherwise
========================  ======================================================================

**Default:** ``None`` (not specified)

----

.. _config-build_command_env:

``build_command_env``
"""""""""""""""""""""

*Introduced in v9.7.2*

**Type:** ``Optional[list[str]]``

List of environment variables to include or pass-through on to the build command that executes
during :ref:`cmd-version`.

This configuration option allows the user to extend the list of environment variables
from the table above in :ref:`config-build_command`. The input is a list of strings
where each individual string handles a single variable definition. There are two formats
accepted and are detailed in the following table:

==================  ===================================================================
FORMAT              Description
==================  ===================================================================
``VAR_NAME``        Detects value from the PSR process environment, and passes value to
                    ``build_command`` process

``VAR_NAME=value``  Sets variable name to value inside of ``build_command`` process
==================  ===================================================================

.. note:: Although variable name capitalization is not required, it is recommended as
          to be in-line with the POSIX-compliant recommendation for shell variable names.

**Default:** ``None`` (not specified)

----

.. _config-changelog:

``changelog``
"""""""""""""

This section outlines the configuration options available that modify changelog generation.

.. note::
    **pyproject.toml:** ``[tool.semantic_release.changelog]``

    **releaserc.toml:** ``[semantic_release.changelog]``

    **releaserc.json:** ``{ "semantic_release": { "changelog": {} } }``

----

.. _config-changelog-changelog_file:

``changelog_file``
******************

.. warning::
    *Deprecated in v9.11.0.* This setting has been moved to
    :ref:`changelog.default_templates.changelog_file <config-changelog-default_templates-changelog_file>`
    for a more logical grouping. This setting will be removed in a future major release.

**Type:** ``str``

Specify the name of the changelog file that will be created. This file will be created
or overwritten (if it previously exists) with the rendered default template included
with Python Semantic Release.

Depending on the file extension of this setting, the changelog will be rendered in the
format designated by the extension. PSR, as of v9.11.0, provides a default changelog template
in both Markdown (``.md``) and reStructuredText (``.rst``) formats. If the file extension is
not recognized, the changelog will be rendered in Markdown format, unless the
:ref:`config-changelog-default_templates-output_format` setting is set.

If you are using the ``template_dir`` setting for providing customized templates,
this setting is not used. See :ref:`config-changelog-template_dir` for more information.

**Default:** ``"CHANGELOG.md"``

----

.. _config-changelog-default_templates:

``default_templates``
*********************

.. note::
    This section of the configuration contains options which customize or modify
    the default changelog templates included with PSR.

    **pyproject.toml:** ``[tool.semantic_release.changelog.default_templates]``

    **releaserc.toml:** ``[semantic_release.changelog.default_templates]``

    **releaserc.json:** ``{ "semantic_release": { "changelog": { "default_templates": {} } } }``

----

.. _config-changelog-default_templates-changelog_file:

``changelog_file``
''''''''''''''''''

*Introduced in v9.11.0.*

**Type:** ``str``

Specify the name of the changelog file that will be created. This file will be created
or overwritten (if it previously exists) with the rendered default template included
with Python Semantic Release.

Depending on the file extension of this setting, the changelog will be rendered in the
format designated by the extension. PSR, as of v9.11.0, provides a default changelog template
in both Markdown (``.md``) and reStructuredText (``.rst``) formats. If the file extension is
not recognized, the changelog will be rendered in Markdown format, unless the
:ref:`config-changelog-default_templates-output_format` setting is set.

If you are using the ``template_dir`` setting for providing customized templates,
this setting is not used. See :ref:`config-changelog-template_dir` for more information.

**Default:** ``"CHANGELOG.md"``

----

.. _config-changelog-default_templates-mask_initial_release:

``mask_initial_release``
''''''''''''''''''''''''

*Introduced in v9.14.0*

**Type:** ``bool``

This option toggles the behavior of the changelog and release note templates to mask
the release details specifically for the first release. When set to ``true``, the
first version release notes will be masked with a generic message as opposed to the
usual commit details.  When set to ``false``, the release notes will be generated as
normal.

The reason for this setting is to improve clarity to your audience. It conceptually
does **NOT** make sense to have a list of changes (i.e. a Changelog) for the first release
since nothing has been published yet, therefore in the eyes of your consumers what change
is there to document?

The message details can be found in the ``first_release.md.j2`` and ``first_release.rst.j2``
templates of the default changelog template directory.

*Default changed to ``true`` in v10.0.0.*

**Default:** ``true``

.. seealso::
   - :ref:`changelog-templates-default_changelog`

----

.. _config-changelog-default_templates-output_format:

``output_format``
'''''''''''''''''

*Introduced in v9.10.0*

**Type:** ``Literal["md", "rst"]``

This setting is used to specify the output format the default changelog template
will use when rendering the changelog. PSR supports both Markdown (``md``) and
reStructuredText (``rst``) formats.

This setting will take precedence over the file extension of the
:ref:`config-changelog-default_templates-changelog_file` setting. If this setting is
omitted, the file extension of the :ref:`config-changelog-default_templates-changelog_file`
setting will be used to determine the output format. If the file extension is not recognized,
the output format will default to Markdown.

**Default:** ``"md"``

.. seealso::
   - :ref:`config-changelog-default_templates-changelog_file`

----

.. _config-changelog-environment:

``environment``
***************

.. note::
   This section of the configuration contains options which customize the template
   environment used to render templates such as the changelog. Most options are
   passed directly to the `jinja2.Environment`_ constructor, and further
   documentation one these parameters can be found there.

    **pyproject.toml:** ``[tool.semantic_release.changelog.environment]``

    **releaserc.toml:** ``[semantic_release.changelog.environment]``

    **releaserc.json:** ``{ "semantic_release": { "changelog": { "environment": {} } } }``

.. _`jinja2.Environment`: https://jinja.palletsprojects.com/en/3.1.x/api/#jinja2.Environment

----

.. _config-changelog-environment-autoescape:

``autoescape``
''''''''''''''

**Type:** ``Union[str, bool]``

If this setting is a string, it should be given in ``module:attr`` form; Python
Semantic Release will attempt to dynamically import this string, which should
represent a path to a suitable callable that satisfies the following:

    As of Jinja 2.4 this can also be a callable that is passed the template name
    and has to return ``true`` or ``false`` depending on autoescape should be
    enabled by default.

The result of this dynamic import is passed directly to the `jinja2.Environment`_
constructor.

If this setting is a boolean, it is passed directly to the `jinja2.Environment`_
constructor.

**Default:** ``false``

----

.. _config-changelog-environment-block_start_string:

``block_start_string``
''''''''''''''''''''''

**Type:** ``str``

This setting is passed directly to the `jinja2.Environment`_ constructor.

**Default:** ``"{%"``

----

.. _config-changelog-environment-block_end_string:

``block_end_string``
''''''''''''''''''''

**Type:** ``str``

This setting is passed directly to the `jinja2.Environment`_ constructor.

**Default:** ``"%}"``

----

.. _config-changelog-environment-comment_start_string:

``comment_start_string``
''''''''''''''''''''''''

**Type:** ``str``

This setting is passed directly to the `jinja2.Environment`_ constructor.

**Default:** ``{#``

----

.. _config-changelog-environment-comment_end_string:

``comment_end_string``
''''''''''''''''''''''

**Type:** ``str``

This setting is passed directly to the `jinja2.Environment`_ constructor.

**Default:** ``"#}"``

----

.. _config-changelog-environment-extensions:

``extensions``
''''''''''''''

**Type:** ``list[str]``

This setting is passed directly to the `jinja2.Environment`_ constructor.

**Default:** ``[]``

----

.. _config-changelog-environment-keep_trailing_newline:

``keep_trailing_newline``
'''''''''''''''''''''''''

**Type:** ``bool``

This setting is passed directly to the `jinja2.Environment`_ constructor.

**Default:** ``false``

----

.. _config-changelog-environment-line_comment_prefix:

``line_comment_prefix``
'''''''''''''''''''''''

**Type:** ``Optional[str]``

This setting is passed directly to the `jinja2.Environment`_ constructor.

**Default:** ``None`` (not specified)

----

.. _config-changelog-environment-line_statement_prefix:

``line_statement_prefix``
'''''''''''''''''''''''''

**Type:** ``Optional[str]``

This setting is passed directly to the `jinja2.Environment`_ constructor.

**Default:** ``None`` (not specified)

----

.. _config-changelog-environment-lstrip_blocks:

``lstrip_blocks``
'''''''''''''''''

**Type:** ``bool``

This setting is passed directly to the `jinja2.Environment`_ constructor.

**Default:** ``false``

----

.. _config-changelog-environment-newline_sequence:

``newline_sequence``
''''''''''''''''''''

**Type:** ``Literal["\n", "\r", "\r\n"]``

This setting is passed directly to the `jinja2.Environment`_ constructor.

**Default:** ``"\n"``

----

.. _config-changelog-environment-trim_blocks:

``trim_blocks``
'''''''''''''''

**Type:** ``bool``

This setting is passed directly to the `jinja2.Environment`_ constructor.

**Default:** ``false``

----

.. _config-changelog-environment-variable_start_string:

``variable_start_string``
'''''''''''''''''''''''''

**Type:** ``str``

This setting is passed directly to the `jinja2.Environment`_ constructor.

**Default:** ``"{{"``

----

.. _config-changelog-environment-variable_end_string:

``variable_end_string``
'''''''''''''''''''''''

**Type:** ``str``

This setting is passed directly to the `jinja2.Environment`_ constructor.

**Default:** ``"}}"``

----

.. _config-changelog-exclude_commit_patterns:

``exclude_commit_patterns``
***************************

**Type:** ``list[str]``

Any patterns specified here will be excluded from the commits which are available
to your changelog. This allows, for example, automated commits to be removed if desired.
Python Semantic Release also removes its own commits from the Changelog via this mechanism;
therefore if you change the automated commit message that Python Semantic Release uses when
making commits, you may wish to add the *old* commit message pattern here.

The patterns in this list are treated as regular expressions.

**Default:** ``[]``

----

.. _config-changelog-mode:

``mode``
********

*Introduced in v9.10.0. Default changed to `update` in v10.0.0.*

**Type:** ``Literal["init", "update"]``

This setting is a flag that is ultimately passed into the changelog context environment. It sets
the value of ``context.changelog_mode`` to a string value of either ``init`` or ``update``.

When used with the provided changelog template, it will determine the behavior of how the changelog
is written. When the mode is set to ``init``, the changelog file will be written from scratch,
overwriting any existing changelog file. This is the ``v8`` and ``v9`` default behavior.

When the mode is set to ``update``, the changelog file will look for the ``insertion_flag`` value
in the changelog file (defined by :ref:`config-changelog-changelog_file`) and insert the new
version information at that location.

If you are using a custom template directory, the `context.changelog_mode` value will exist in the
changelog context but it is up to your implementation to determine if and/or how to use it.

**Default:** ``update``

.. seealso::
   - :ref:`changelog-templates-default_changelog`

----

.. _config-changelog-insertion_flag:

``insertion_flag``
******************

*Introduced in v9.10.0*

**Type:** ``str``

A string that will be used to identify where the new version should be inserted into the
changelog file (as defined by :ref:`config-changelog-changelog_file`) when the changelog mode
is set to ``update``.

If you modify this value in your config, you will need to manually update any saved changelog
file to match the new insertion flag if you use the ``update`` mode.  In ``init`` mode, the
changelog file will be overwritten as normal.

In v9.11.0, the ``insertion_flag`` default value became more dynamic with the introduction of
an reStructuredText template. The default value will be set depending on the
:ref:`config-changelog-default_templates-output_format` setting. The default flag values are:

==================  =========================
Output Format       Default Insertion Flag
==================  =========================
Markdown (``md``)   ``<!-- version list -->``
reStructuredText    ``..\n    version list``
==================  =========================

**Default:** various, see above

----

.. _config-changelog-template_dir:

``template_dir``
****************

**Type:** ``str``

When files exist within the specified directory, they will be used as templates for
the changelog rendering process. Regardless if the directory includes a changelog file,
the provided directory will be rendered and files placed relative to the root of the
project directory.

No default changelog template or release notes template will be used when this directory
exists and the directory is not empty. If the directory is empty, the default changelog
template will be used.

This option is discussed in more detail at :ref:`changelog-templates`

**Default:** ``"templates"``

----

.. _config-commit_author:

``commit_author``
"""""""""""""""""

**Type:** ``str``

Author used in commits in the format ``name <email>``.

.. note::
  If you are using the built-in GitHub Action, the default value is set to
  ``github-actions <actions@github.com>``. You can modify this with the
  ``git_committer_name`` and ``git_committer_email`` inputs.

.. seealso::
   - :ref:`gh_actions`

**Default:** ``semantic-release <semantic-release>``

----

.. _config-commit_message:

``commit_message``
""""""""""""""""""

**Type:** ``str``

Commit message to use when making release commits. The message can use ``{version}``
as a format key, in which case the version being released will be formatted into
the message.

If at some point in your project's lifetime you change this, you may wish to consider,
adding the old message pattern(s) to :ref:`exclude_commit_patterns <config-changelog-exclude_commit_patterns>`.

**Default:** ``"{version}\n\nAutomatically generated by python-semantic-release"``

----

.. _config-commit_parser:

``commit_parser``
"""""""""""""""""

**Type:** ``str``

Specify which commit parser Python Semantic Release should use to parse the commits
within the Git repository.

Built-in parsers:
    * ``angular`` - :ref:`AngularCommitParser <commit_parser-builtin-angular>` *(deprecated in v9.19.0)*
    * ``conventional`` - :ref:`ConventionalCommitParser <commit_parser-builtin-conventional>` *(available in v9.19.0+)*
    * ``conventional-monorepo`` - :ref:`ConventionalCommitMonorepoParser <commit_parser-builtin-conventional-monorepo>` *(available in v10.4.0+)*
    * ``emoji`` - :ref:`EmojiCommitParser <commit_parser-builtin-emoji>`
    * ``scipy`` - :ref:`ScipyCommitParser <commit_parser-builtin-scipy>`
    * ``tag`` - :ref:`TagCommitParser <commit_parser-builtin-tag>` *(deprecated in v9.12.0)*

You can set any of the built-in parsers by their keyword but you can also specify
your own commit parser in ``path/to/module_file.py:Class`` or ``module:Class`` form.

For more information see :ref:`commit_parsing`.

**Default:** ``"conventional"``

----

.. _config-commit_parser_options:

``commit_parser_options``
"""""""""""""""""""""""""

**Type:** ``dict[str, Any]``

This set of options are passed directly to the commit parser class specified in
:ref:`the commit parser <config-commit_parser>` configuration option.

For more information (to include defaults), see
:ref:`commit_parser-builtin-customization`.

**Default:** ``ParserOptions { ... }``, where ``...`` depends on
:ref:`commit_parser <config-commit_parser>`.

----

.. _config-logging_use_named_masks:

``logging_use_named_masks``
"""""""""""""""""""""""""""

**Type:** ``bool``

Whether or not to replace secrets identified in logging messages with named masks
identifying which secrets were replaced, or use a generic string to mask them.

**Default:** ``false``

----

.. _config-major_on_zero:

``major_on_zero``
"""""""""""""""""

**Type:** ``bool``

This flag controls whether or not Python Semantic Release will increment the major
version upon a breaking change when the version matches ``0.y.z``. This value is
set to ``true`` by default, where breaking changes will increment the ``0`` major
version to ``1.0.0`` like normally expected.

If set to ``false``, major (breaking) releases will increment the minor digit of the
version while the major version is ``0``, instead of the major digit. This allows for
continued breaking changes to be made while the major version remains ``0``.

From the `Semantic Versioning Specification`_:

   Major version zero (0.y.z) is for initial development. Anything MAY change at
   any time. The public API SHOULD NOT be considered stable.

.. _Semantic Versioning Specification: https://semver.org/spec/v2.0.0.html#spec-item-4

When you are ready to release a stable version, set ``major_on_zero`` to ``true`` and
run Python Semantic Release again. This will increment the major version to ``1.0.0``.

When :ref:`config-allow_zero_version` is set to ``false``, this setting is ignored.

**Default:** ``true``

----

.. _config-no_git_verify:

``no_git_verify``
"""""""""""""""""

*Introduced in v9.8.0*

**Type:** ``bool``

This flag is passed along to ``git`` upon performing a ``git commit`` during :ref:`cmd-version`.

When true, it will bypass any git hooks that are set for the repository when Python Semantic
Release makes a version commit.  When false, the commit is performed as normal. This option
has no effect when there are not any git hooks configured nor when the ``--no-commit`` option
is passed.

**Default:** ``false``

----

.. _config-publish:

``publish``
"""""""""""

This section defines configuration options that modify :ref:`cmd-publish`.

.. note::
    **pyproject.toml:** ``[tool.semantic_release.publish]``

    **releaserc.toml:** ``[semantic_release.publish]``

    **releaserc.json:** ``{ "semantic_release": { "publish": {} } }``

----

.. _config-publish-dist_glob_patterns:

``dist_glob_patterns``
**********************

**Type:** ``list[str]``

Upload any files matching any of these globs to your VCS release. Each item in this
list should be a string containing a Unix-style glob pattern.

**Default:** ``["dist/*"]``

----

.. _config-publish-upload_to_vcs_release:

``upload_to_vcs_release``
*************************

**Type:** ``bool``

If set to ``true``, upload any artifacts matched by the
:ref:`dist_glob_patterns <config-publish-dist_glob_patterns>` to the release created
in the remote VCS corresponding to the latest tag. Artifacts are only uploaded if
release artifact uploads are supported by the :ref:`VCS type <config-remote-type>`.

**Default:** ``true``

----

.. _config-remote:

``remote``
""""""""""

The remote configuration is a group of settings that configure PSR's integration
with remote version control systems.

.. note::
    **pyproject.toml:** ``[tool.semantic_release.remote]``

    **releaserc.toml:** ``[semantic_release.remote]``

    **releaserc.json:** ``{ "semantic_release": { "remote": {} } }``

----

.. _config-remote-api_domain:

``api_domain``
**************

**Type:** ``Optional[str | Dict['env', str]]``

The hosting domain for the API of your remote HVCS if different than the ``domain``.
Generally, this will be used to specify a separate subdomain that is used for API
calls rather than the primary domain (ex. ``api.github.com``).

**Most on-premise HVCS installations will NOT use this setting!** Whether or not
this value is used depends on the HVCS configured (and your server administration)
in the :ref:`remote.type <config-remote-type>` setting and used in tandem with the
:ref:`remote.domain <config-remote-domain>` setting.

When using a custom :ref:`remote.domain <config-remote-domain>` and a HVCS
:ref:`remote.type <config-remote-type>` that is configured with a separate domain
or sub-domain for API requests, this value is used to configure the location of API
requests that are sent from PSR.

Most on-premise or self-hosted HVCS environments will use a path prefix to handle inbound
API requests, which means this value will ignored.

PSR knows the expected api domains for known cloud services and their associated
api domains which means this value is not necessary to explicitly define for services
as ``bitbucket.org``, and ``github.com``.

Including the protocol schemes, such as ``https://``, for the API domain is optional.
Secure ``HTTPS`` connections are assumed unless the setting of
:ref:`remote.insecure <config-remote-insecure>` is ``true``.

**Default:** ``None``

----

.. _config-remote-domain:

``domain``
**********

**Type:** ``Optional[str | Dict['env', str]]``

The host domain for your HVCS server. This setting is used to support on-premise
installations of HVCS providers with custom domain hosts.

If you are using the official domain of the associated
:ref:`remote.type <config-remote-type>`, this value is not required. PSR will use the
default domain value for the :ref:`remote.type <config-remote-type>` when not specified.
For example, when ``remote.type="github"`` is specified the default domain of
``github.com`` is used.

Including the protocol schemes, such as ``https://``, for the domain value is optional.
Secure ``HTTPS`` connections are assumed unless the setting of
:ref:`remote.insecure <config-remote-insecure>` is ``true``.

This setting also supports reading from an environment variable for ease-of-use
in CI pipelines. See :ref:`Environment Variable <config-environment-variables>` for
more information. Depending on the :ref:`remote.type <config-remote-type>`, the default
environment variable for the default domain's CI pipeline environment will automatically
be checked so this value is not required in default environments.  For example, when
``remote.type="gitlab"`` is specified, PSR will look to the ``CI_SERVER_URL`` environment
variable when ``remote.domain`` is not specified.

**Default:** ``None``

.. seealso::
   - :ref:`remote.api_domain <config-remote-api_domain>`

----

.. _config-remote-ignore_token_for_push:

``ignore_token_for_push``
*************************

**Type:** ``bool``

If set to ``true``, ignore the authentication token when pushing changes to the remote.
This is ideal, for example, if you already have SSH keys set up which can be used for
pushing.

**Default:** ``false``

----

.. _config-remote-insecure:

``insecure``
************

*Introduced in v9.4.2*

**Type:** ``bool``

Insecure is used to allow non-secure ``HTTP`` connections to your HVCS server. If set to
``true``, any domain value passed will assume ``http://`` if it is not specified and allow
it. When set to ``false`` (implicitly or explicitly), it will force ``https://`` communications.

When a custom ``domain`` or ``api_domain`` is provided as a configuration, this flag governs
the protocol scheme used for those connections. If the protocol scheme is not provided in
the field value, then this ``insecure`` option defines whether ``HTTP`` or ``HTTPS`` is
used for the connection. If the protocol scheme is provided in the field value, it must
match this setting or it will throw an error.

The purpose of this flag is to prevent any typos in provided ``domain`` and ``api_domain``
values that accidentally specify an insecure connection but allow users to toggle the protection
scheme off when desired.

**Default:** ``false``

----

.. _config-remote-name:

``name``
********

**Type:** ``str``

Name of the remote to push to using ``git push -u $name <branch_name>``

**Default:** ``"origin"``

----

.. _config-remote-token:

``token``
*********

**Type:** ``Optional[str | Dict['env', str]]``

:ref:`Environment Variable <config-environment-variables>` from which to source the
authentication token for the remote VCS. Common examples include ``"GH_TOKEN"``,
``"GITLAB_TOKEN"`` or ``"GITEA_TOKEN"``, however, you may choose to use a custom
environment variable if you wish.

.. note::
   By default, this is a **mandatory** environment variable that must be set before
   using any functionality that requires authentication with your remote VCS. If you
   are using this token to enable push access to the repository, it must also be set
   before attempting to push.

   If your push access is enabled via SSH keys instead, then you do not need to set
   this environment variable in order to push the version increment, changelog and
   modified source code assets to the remote using :ref:`cmd-version`. However,
   you will need to disable release creation using the :ref:`cmd-version-option-vcs-release`
   option, among other options, in order to use Python Semantic Release without
   configuring the environment variable for your remote VCS authentication token.


The default value for this setting depends on what you specify as
: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" }``
``"bitbucket"``   ->  ``{ env = "BITBUCKET_TOKEN" }``
================  ==  ===============================

**Default:** ``{ env = "<envvar name>" }``, where ``<envvar name>`` depends on
:ref:`remote.type <config-remote-type>` as indicated above.

----

.. _config-remote-type:

``type``
********

**Type:** ``Literal["bitbucket", "gitea", "github", "gitlab"]``

The type of the remote VCS. Currently, Python Semantic Release supports ``"github"``,
``"gitlab"``, ``"gitea"`` and ``"bitbucket"``. Not all functionality is available with all
remote types, but we welcome pull requests to help improve this!

**Default:** ``"github"``

----

.. _config-remote-url:

``url``
*******

**Type:** ``Optional[str | Dict['env', str]]``

An override setting used to specify the remote upstream location of ``git push``.

**Not commonly used!** This is used to override the derived upstream location when
the desired push location is different than the location the repository was cloned
from.

This setting will override the upstream location url that would normally be derived
from the :ref:`remote.name <config-remote-name>` location of your git repository.

**Default:** ``None``

----

.. _config-repo_dir:

``repo_dir``
""""""""""""

**Type:** ``str``

Specify the directory of the Git repository. This is used to determine the location of
the repository for various operations, such as creating tags and commits. PSR will attempt
to automatically determine the location of the repository in parent directories of the
current working directory but will emit a warning if it is higher than this defined value.

If a git repository is not found from this location or any parent directories, PSR will
raise an error and exit.

**Default:** ``"."``

----

.. _config-tag_format:

``tag_format``
""""""""""""""

**Type:** ``str``

Specify the format to be used for the Git tag that will be added to the repo during
a release invoked via :ref:`cmd-version`. The string is used as a template for the tag
name, and must include the ``{version}`` format key.

This format will also be used for parsing tags already present in the repository into
semantic versions; therefore if the tag format changes at some point in the
repository's history, historic versions that no longer match this pattern will not be
considered as versions.

================ =========  ==========================================================
Format Key       Mandatory  Contents
================ =========  ==========================================================
``{version}``    Yes        The new semantic version number, for example ``1.2.3``, or
                            ``2.1.0-alpha.1+build.1234``
================ =========  ==========================================================

Tags which do not match this format will not be considered as versions of your project.

This is critical for Monorepo projects where the tag format defines which package the
version tag belongs to. Generally, the tag format for each package of the monorepo will
include the package name as the prefix of the tag format. For example, if the package
is named ``pkg1``, the tag format would be ``pkg1-v{version}`` and in the other package
``pkg2``, the tag format would be ``pkg2-v{version}``. This allows PSR to determine
which tags to use to determine the version for each package.

**Default:** ``"v{version}"``

----

.. _config-version_toml:

``version_toml``
""""""""""""""""

**Type:** ``list[str]``

This configuration option is similar to :ref:`config-version_variables`, but it uses
a TOML parser to interpret the data structure before, inserting the version. This
allows users to use dot-notation to specify the version via the logical structure
within the TOML file, which is more accurate than a pattern replace.

The ``version_toml`` option is commonly used to update the version number in the project
definition file: ``pyproject.toml`` as seen in the example below.

As of v9.20.0, the ``version_toml`` option accepts a colon-separated definition
with either 2 or 3 parts. The 2-part definition includes the file path and the version
parameter (in dot-notation). Newly with v9.20.0, it also accepts an optional
3rd part to allow configuration of the format type.

**Available Format Types**

- ``nf``: Number format (ex. ``1.2.3``)
- ``tf``: :ref:`Tag Format <config-tag_format>` (ex. ``v1.2.3``)

If the format type is not specified, it will default to the number format.

**Example**

.. code-block:: toml

    [semantic_release]
    version_toml = [
        # "file:variable:[format_type]"
        "pyproject.toml:tool.poetry.version",  # Implied Default: Number format
        "definition.toml:project.version:nf",  # Number format
        "definition.toml:project.release:tf",  # Tag format
    ]

This configuration will result in the following changes:

.. code-block:: diff

    diff a/pyproject.toml b/pyproject.toml

      [tool.poetry]
    - version = "0.1.0"
    + version = "0.2.0"

.. code-block:: diff

    diff a/definition.toml b/definition.toml

      [project]
      name = "example"

    - version = "0.1.0"
    + version = "0.1.0"

    - release = "v0.1.0"
    + release = "v0.2.0"

**Default:** ``[]``

----

.. _config-version_variables:

``version_variables``
"""""""""""""""""""""

**Type:** ``list[str]``

The ``version_variables`` configuration option is a list of string definitions
that defines where the version number should be updated in the repository, when
a new version is released.

As of v9.20.0, the ``version_variables`` option accepts a
colon-separated definition with either 2 or 3 parts. The 2-part definition includes
the file path and the variable name. Newly with v9.20.0, it also accepts
an optional 3rd part to allow configuration of the format type.

As of v10.6.0, the ``version_variables`` option also supports entire file
replacement by using an asterisk (``*``) as the pattern/variable name. This is useful
for files that contain only a version number, such as ``VERSION`` files.

**Available Format Types**

- ``nf``: Number format (ex. ``1.2.3``)
- ``tf``: :ref:`Tag Format <config-tag_format>` (ex. ``v1.2.3``)

If the format type is not specified, it will default to the number format.

Prior to v9.20.0, PSR only supports entries with the first 2-parts
as the tag format type was not available and would only replace numeric
version numbers.

**Example**

.. code-block:: toml

    [semantic_release]
    tag_format = "v{version}"
    version_variables = [
        # "file:variable:format_type"
        "src/semantic_release/__init__.py:__version__",  # Implied Default: Number format
        "docs/conf.py:version:nf",                       # Number format for sphinx docs
        "kustomization.yml:newTag:tf",                   # Tag format
        # File replacement (entire file content is replaced with version)
        "VERSION:*:nf",                                  # Replace entire file with number format
        "RELEASE:*:tf",                                  # Replace entire file with tag format
    ]

First, the ``__version__`` variable in ``src/semantic_release/__init__.py`` will be updated
with the next version using the `SemVer`_ number format.

.. code-block:: diff

    diff a/src/semantic_release/__init__.py b/src/semantic_release/__init__.py

    - __version__ = "0.1.0"
    + __version__ = "0.2.0"

Then, the ``version`` variable in ``docs/conf.py`` will be updated with the next version
with the next version using the `SemVer`_ number format because of the explicit ``nf``.

.. code-block:: diff

    diff a/docs/conf.py b/docs/conf.py

    - version = "0.1.0"
    + version = "0.2.0"

Then, the ``newTag`` variable in ``kustomization.yml`` will be updated with the next version
with the next version using the configured :ref:`config-tag_format` because the definition
included ``tf``.

.. code-block:: diff

    diff a/kustomization.yml b/kustomization.yml

      images:
        - name: repo/image
    -     newTag: v0.1.0
    +     newTag: v0.2.0

Next, the entire content of the ``VERSION`` file will be replaced with the next version
using the `SemVer`_ number format (because of the ``*`` pattern and ``nf`` format type).

.. code-block:: diff

    diff a/VERSION b/VERSION

    - 0.1.0
    + 0.2.0

Finally, the entire content of the ``RELEASE`` file will be replaced with the next version
using the configured :ref:`config-tag_format` (because of the ``*`` pattern and ``tf`` format type).

.. code-block:: diff

    diff a/RELEASE b/RELEASE

    - v0.1.0
    + v0.2.0

**How It works**

Each version variable will be transformed into either a Regular Expression (for pattern-based
replacement) or a file replacement operation (when using the ``*`` pattern).

**Pattern-Based Replacement**

When a variable name is specified (not ``*``), the replacement algorithm is **ONLY** a
pattern match and replace. It will **NOT** evaluate the code nor will PSR understand
any internal object structures (ie. ``file:object.version`` will not work).

The regular expression generated from the ``version_variables`` definition will:

1. Look for the specified ``variable`` name in the ``file``. The variable name can be
   enclosed by single (``'``) or double (``"``) quotation marks but they must match.

2. The variable name defined by ``variable`` and the version must be separated by
   an operand symbol (``=``, ``:``, ``:=``, or ``@``). Whitespace is optional around
   the symbol. As of v10.0.0, a double-equals (``==``) operator is also supported
   as a valid operand symbol. As of v10.5.0, PSR can omit all operands as long
   as there is at least one whitespace character between the variable name and the version.

3. The value of the variable must match a `SemVer`_ regular expression and can be
   enclosed by single (``'``) or double (``"``) quotation marks but they must match. However,
   the enclosing quotes of the value do not have to match the quotes surrounding the variable
   name.

4. If the format type is set to ``tf`` then the variable value must have the matching prefix
   and suffix of the :ref:`config-tag_format` setting around the `SemVer`_ version number.

Given the pattern matching nature of this feature, the Regular Expression is able to
support most file formats because of the similarity of variable declaration across
programming languages. PSR specifically supports Python, YAML, and JSON as these have
been the most commonly requested formats. This configuration option will also work
regardless of file extension because it looks for a matching pattern string.

.. note::
    This will also work for TOML but we recommend using :ref:`config-version_toml` for
    TOML files as it actually will interpret the TOML file and replace the version
    number before writing the file back to disk.

**File Replacement**

When the pattern/variable name is specified as an asterisk (``*``), the entire file content
will be replaced with the version string. This is useful for files that contain only a
version number, such as ``VERSION`` files or similar single-line version storage files.

The file replacement operation:

1. Reads the current file content if it exists (any whitespace is stripped)
2. Sets or replaces the entire file content with the new version string
3. Writes the new version back to the file (with only a single trailing newline)

The format type (``nf`` or ``tf``) determines whether the version is written as a
plain number (e.g., ``1.2.3``) or with the :ref:`config-tag_format` prefix/suffix
(e.g., ``v1.2.3``).

**Examples of Pattern-Based Replacement**

This is a comprehensive list (but not all variations) of examples where the following versions
will be matched and replaced by the new version:

.. code-block::

    # Common variable declaration formats
    version='1.2.3'
    version = "1.2.3"
    release = "v1.2.3"     # if tag_format is set

    # YAML
    version: 1.2.3

    # JSON
    "version": "1.2.3"

    # NPM & GitHub Actions YAML
    version@1.2.3
    version@v1.2.3        # if tag_format is set

    # Walrus Operator
    version := "1.2.3"

    # Excessive whitespace
    version        =    '1.2.3'

    # Mixed Quotes
    "version" = '1.2.3'

    # Custom Tag Format with tag_format set (monorepos)
    __release__ = "module-v1.2.3"

    # requirements.txt
    my-package == 1.2.3

    # C-Macro style (no operand only whitespace required)
    #define VERSION "1.2.3"

.. important::
    The Regular Expression expects a version value to exist in the file to be replaced.
    It cannot be an empty string or a non-semver compliant string. If this is the very
    first time you are using PSR, we recommend you set the version to ``0.0.0``.

    This may become more flexible in the future with resolution of issue `#941`_.

.. _#941: https://github.com/python-semantic-release/python-semantic-release/issues/941

.. warning::
    If the file (ex. JSON) you are replacing has two of the same variable name in it,
    this pattern match will not be able to differentiate between the two and will replace
    both. This is a limitation of the pattern matching and not a bug.

**Default:** ``[]``

.. _SemVer: https://semver.org/
