docs(customization): verify executable no-bump plugin example - #2098
Draft
bearomorphism wants to merge 1 commit into
Draft
bearomorphism wants to merge 1 commit into
bearomorphism wants to merge 1 commit into
Conversation
Contributor
🔍 Commitizen bump previewMerging this PR will produce the following bump: |
|
bearomorphism
marked this pull request as draft
October 3, 2026 09:15
bearomorphism
force-pushed
the
fm/commitizen-doc-example-checks
branch
from
October 5, 2026 06:48
1b4d492 to
a5b92a1
Compare
This branch has not been deployed
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description
This draft follow-up verifies the published Python-class bump-rule example from a single shared source.
It updates the docs to include
docs/examples/cz_docs_only.py, type-checks that example through the normal mypy path, and adds focused runtime tests proving thatbump_map = {"docs": None}yields no increment fordocs:commits whilefix:commits still produce a PATCH bump. The example pattern is also tightened so nearby false positives such asfixup!,fixture, andfix!do not silently produce a bump.Checklist
Was generative AI tooling used to co-author this PR?
Generated-by: Pi following the guidelines
Code Changes
uv run poe alllocally to ensure this change passes linter check and testsDocumentation Changes
uv run poe doclocally to ensure the documentation pages renders correctlyExpected Behavior
The documented custom plugin example is the same Python file that documentation publishes, mypy checks, and the test suite executes. A
docs:commit matched by that example produces no increment, a normalfix:commit produces a PATCH increment, and nearby false positives such asfixup!,fixture, andfix!do not silently produce a PATCH bump.Steps to Test This Pull Request
uv run ruff check.uv run mypy.uv run pytest tests/commands/test_documented_python_class_examples.py.uv run prek run --all-files.uv run mkdocs build.docs/customization/python_class.mdincludesdocs/examples/cz_docs_only.pyand that the example remains consistent with the tested module.Additional Context
masterNonetyping support this follow-up now verifies in the published docs example: refactor(bump): use VersionIncrement ordering for bump detection #2097