Fix/docs by woile · Pull Request #1924 · commitizen-tools/commitizen · GitHub
Skip to content

Fix/docs - #1924

Merged
woile merged 4 commits into
masterfrom
fix/docs
Apr 7, 2026
Merged

Fix/docs#1924
woile merged 4 commits into
masterfrom
fix/docs

Conversation

@woile

@woile woile commented Apr 5, 2026

Copy link
Copy Markdown
Member

Description

  • Closes Broken docs #1922
  • Improves readability of docs
  • Recommend semver2 during init (if not python)

Checklist

Was generative AI tooling used to co-author this PR?

NO

Code Changes

  • Add test cases to all the changes you introduce
  • Run uv run poe all locally to ensure this change passes linter check and tests
  • Manually test the changes:
    • Verify the feature/bug fix works as expected in real-world scenarios
    • Test edge cases and error conditions
    • Ensure backward compatibility is maintained
    • Document any manual testing steps performed
  • Update the documentation for the changes

Documentation Changes

  • Run uv run poe doc locally to ensure the documentation pages renders correctly
  • Check and fix any broken links (internal or external)

Expected Behavior

Steps to Test This Pull Request

For the init:

  1. Create new folder with mkdir -p /tmp/app && cd /tmp/app
  2. cz init
  3. Observe

Additional Context

@woile
woile requested review from Lee-W and noirbizarre as code owners April 5, 2026 09:46
woile
woile commented Apr 5, 2026
View reviewed changes
Comment thread docs/commands/bump.md
@codecov

codecov Bot commented Apr 5, 2026 •
edited
Loading

Copy link
Copy Markdown

@woile
woile requested a review from bearomorphism April 5, 2026 09:49
@bearomorphism
bearomorphism requested a review from Copilot April 6, 2026 09:37
Copilot AI reviewed Apr 6, 2026
View reviewed changes

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

This PR updates Commitizen’s documentation structure/readability (addressing broken docs discoverability) and adjusts default versioning guidance/behavior toward semver2 for non-Python projects, alongside CI workflow modernization for bump/release automation.

Changes:

  • Update docs navigation and config docs (including adding version_provider/version_scheme details and reorganizing sidebar entries).
  • Change the default version scheme selection for non-Python projects from semver to semver2 (plus related test updates).
  • Revise GitHub Actions workflows to bump/tag/release via cz + gh, and enable manual publish dispatch.

Reviewed changes

Copilot reviewed 14 out of 15 changed files in this pull request and generated 9 comments.

Show a summary per file
File Description
tests/test_project_info.py Updates expectations for default version_scheme to semver2.
tests/commands/test_bump_command.py Formatting-only change to parametrized test ids lambda.
pyproject.toml Updates metadata/deps and build settings; adjusts Commitizen tool config.
mkdocs.yml Reorders configuration nav to improve discoverability.
docs/tutorials/github_actions.md Adds a tip pointing to setup-cz.
docs/config/version_provider.md Spacing/readability tweaks around configuration examples.
docs/config/option.md Renames “Misc” to “General” and expands option descriptions.
docs/config/bump.md Adds version_provider/version_scheme sections and details.
docs/commands/changelog.md Improves option docs with config-file examples and wording.
docs/commands/bump.md Relocates/rewrites --version-scheme docs and examples.
commitizen/project_info.py Defaults non-Python projects to semver2.
commitizen/exceptions.py Adds type annotations for exception attributes.
.github/workflows/pythonpublish.yml Adds workflow_dispatch input and checks out specified ref.
.github/workflows/bumpversion.yml Replaces action-based bump/release with explicit cz + gh steps.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment thread pyproject.toml
Comment thread .github/workflows/pythonpublish.yml
Comment thread .github/workflows/bumpversion.yml
Comment thread .github/workflows/bumpversion.yml
Comment thread docs/tutorials/github_actions.md Outdated
Comment thread docs/config/option.md Outdated
Comment thread docs/config/bump.md Outdated
Comment thread docs/commands/bump.md Outdated
Comment thread docs/commands/changelog.md Outdated
Lee-W
Lee-W reviewed Apr 6, 2026
View reviewed changes

@Lee-W Lee-W left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

a few question and comments. some suggestion from copilot seems to be correct

Comment thread .github/workflows/bumpversion.yml
Comment thread .github/workflows/bumpversion.yml
Comment thread commitizen/exceptions.py
Lee-W
Lee-W approved these changes Apr 7, 2026
View reviewed changes
Comment thread docs/config/option.md Outdated
@woile
woile merged commit 97fb356 into master Apr 7, 2026
20 checks passed
@woile
woile deleted the fix/docs branch April 7, 2026 05:57
@bearomorphism bearomorphism mentioned this pull request Aug 20, 2026
Merged
12 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

Copilot code review Copilot
Copilot review effort, defaults to Lite
Applies to this pull request for everyone.Learn more about Copilot code review.
Copilot left review comments
@Lee-W Lee-W Lee-W approved these changes
@noirbizarre noirbizarre Awaiting requested review from noirbizarre
@bearomorphism bearomorphism Awaiting requested review from bearomorphism

Assignees

No one assigned

Labels

pr-status: wait-for-review type: bug type: documentation

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

Broken docs

3 participants

@woile @Lee-W