Skip to content

added docs #5

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jan 18, 2025
Merged

added docs #5

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
50 changes: 50 additions & 0 deletions docs/configuration.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -809,6 +809,22 @@ For more information see :ref:`commit-parsing`.
``commit_parser_options``
"""""""""""""""""""""""""

This section defines configuration options that modify commit parser options.

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

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

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

----

.. _config-commit_parser_options-types:

``allowed_types``/``minor_types``/``patch_types``
*************************************************

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

These options are passed directly to the ``parser_options`` method of
Expand Down Expand Up @@ -874,6 +890,40 @@ the expections from ``commit_parser`` value to default options value.

----

.. _config-commit_parser_options-path_filters:

``path_filters``
***************************

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

A set of relative paths to filter commits by. Only commits with file changes that
match these file paths or its subdirectories will be considered valid commits.

Syntax is similar to .gitignore with file path globs and inverse file match globs
via ``!`` prefix. Paths should be relative to the current working directory.

**Default:** ``["."]``

----

.. _config-commit_parser_options-scope_prefix:

``scope_prefix``
***************************

**Type:** ``str``

A prefix that will be striped from the scope when parsing commit messages.

If set, it will cause unscoped commits to be ignored. Use this in tandem with
the :ref:`config-commit_parser_options-path_filters` option to filter commits by
directory and scope.

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

----

.. _config-logging_use_named_masks:

``logging_use_named_masks``
Expand Down