Repository navigation
docs: add plugin testing guide - #2122
Open
abdullahjaved06 wants to merge 1 commit into
Open
abdullahjaved06 wants to merge 1 commit into
abdullahjaved06 wants to merge 1 commit into
Conversation
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
Adds a new documentation page (docs/customization/testing_plugins.md) explaining how plugin authors can write automated tests for their Commitizen plugins. It includes a complete example plugin and tests for version bumps, changelog extraction, message creation, and schema validation. Also links to it from python_class.md and adds it to the nav. Closes #937.
Checklist
Was generative AI tooling used to co-author this PR?
Generated-by: Claude 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 new page appears under Advanced Customization → Testing plugins and renders correctly. The example plugin and its tests are copy-pasteable and pass against the current Commitizen release.
Steps to Test This Pull Request
Additional Context