Skip to content

Self-reference in readthedocs getting_started.rst exclude_commit_patterns example. #1291

@mattgebert

Description

@mattgebert

Platform

Windows 11
Version 10.0.26100 Build 26100
Python 3.13.3
(python-)semantic-release version 10.2.0

What's the issue:

The getting started docs on the semantic release webpage suggest the following example for commit exclusion.

To set commit exclusion patterns for a conventional commits parsers, add the following to your
pyproject.toml file:

.. code-block:: toml

[tool.semantic_release.changelog.exclude_commit_patterns]
# Recommended patterns for conventional commits parser that is scope aware
exclude_commit_patterns = [
    '''chore(?:\([^)]*?\))?: .+''',
    '''ci(?:\([^)]*?\))?: .+''',
    '''refactor(?:\([^)]*?\))?: .+''',
    '''style(?:\([^)]*?\))?: .+''',
    '''test(?:\([^)]*?\))?: .+''',
    '''build\((?!deps\): .+)''',
    '''Initial [Cc]ommit.*''',
]

Notably, there is a reference to the exclude_commit_patterns object itself.
Running this configuration in my pyproject.toml and using the demo:

> semantic-release -v --noop version

🛡 You are running in no-operation mode, because the '--noop' flag was supplied
[23:54:38] INFO     Loading configuration from pyproject.toml                                                                                  util.py:77
1 validation error for RawConfig
changelog.exclude_commit_patterns
  Input should be a valid tuple [type=tuple_type, input_value={'exclude_commit_patterns... 'Initial [Cc]ommit.*']}, input_type=dict]
    For further information visit https://errors.pydantic.dev/2.11/v/tuple_type

Solution

Remove .exclude_commit_patterns substring from the toml identifier.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions