Skip to content

docs(getting_started.rst): Remove exclude_commit_pattern self-reference. #1292

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.

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

Conversation

mattgebert
Copy link
Contributor

@mattgebert mattgebert commented Jul 10, 2025

Purpose

Fixes typo in getting started doc. Resolves: #1291

Rationale

Solves issue by removing duplicate naming.

How did you test?

Simple change to docs only, built & examined web output using sphinx-autobuild --open-browser docs docs/_build/html as per contributing guidelines.

How to Verify

Follow getting_started.rst for a basic python package. Output should be

> semantic-release -v --noop version

🛡 You are running in no-operation mode, because the '--noop' flag was supplied
[23:57:33] INFO     Loading configuration from pyproject.toml                                                                                  util.py:77
branch 'main' isn't in any release groups; no release will be made

instead of

> 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

Apologies, haven't used semantic-release yet, so I may have incorrectly done something.


PR Completion Checklist

  • Reviewed & followed the Contributor Guidelines

  • Changes Implemented & Validation pipeline succeeds

  • Commits follow the Conventional Commits standard
    and are separated into the proper commit type and scope (recommended order: test, build, feat/fix, docs)

  • N/A Appropriate Unit tests added/updated

  • N/A Appropriate End-to-End tests added/updated

  • Appropriate Documentation added/updated and syntax validated for sphinx build (see Contributor Guidelines)

@mattgebert mattgebert force-pushed the docfix-exclude_commit_patterns branch from 70d9093 to 7ab60e3 Compare July 10, 2025 14:42
@codejedi365
Copy link
Contributor

Thanks for finding and recommending a fix to my typo.

…s` toml example

removed self-reference for `exclude_commit_patterns`.
@mattgebert mattgebert force-pushed the docfix-exclude_commit_patterns branch from 7ab60e3 to 972b4b9 Compare July 10, 2025 21:45
@mattgebert
Copy link
Contributor Author

No problem, sorry, keep getting the commit message wrong hahah. Forgot to install the pre-commit-hooks.

@codejedi365 codejedi365 merged commit 2ce2e94 into python-semantic-release:master Jul 11, 2025
8 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Self-reference in readthedocs getting_started.rst exclude_commit_patterns example.
2 participants