Visitar URL original
ci: restore changelog updates by bearomorphism · Pull Request #2074 · commitizen-tools/commitizen · GitHub
Skip to content

ci: restore changelog updates - #2074

Merged
bearomorphism merged 2 commits into
masterfrom
bearomorphism-fix-changelog-pipeline
Aug 20, 2026
Merged

ci: restore changelog updates#2074
bearomorphism merged 2 commits into
masterfrom
bearomorphism-fix-changelog-pipeline

Conversation

@bearomorphism

@bearomorphism bearomorphism commented Aug 20, 2026 •
edited
Loading

Copy link
Copy Markdown
Collaborator

Description

The release workflow stopped committing CHANGELOG.md after migrating from commitizen-action to setup-cz, because the replacement configuration no longer enabled changelog updates during cz bump. GitHub release notes continued to be generated into a temporary file, leaving the repository changelog stale after v4.13.9.

This enables changelog generation on bump, uses incremental generation to preserve historical manual edits, and backfills all 13 releases from v4.13.10 through v4.18.0. It also documents release-triggering Conventional Commit and PR title types for AI agents to prevent CI-only changes from causing patch releases.

Checklist

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

  • Yes (GitHub Copilot)

Generated-by: GitHub Copilot following the guidelines

Code Changes

  • Add test cases to all the changes you introduce (N/A: workflow/configuration change covered by existing bump and changelog tests)
  • 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

The repository changelog is backfilled from the existing release tags, and AGENTS.md now explains which commit and PR title types trigger releases.

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

Expected Behavior

Each successful automated version bump commits the new changelog entry to CHANGELOG.md. Incremental generation updates only releases newer than the latest version already present.

Steps to Test This Pull Request

  1. Run uv run cz changelog --incremental twice and confirm the second run leaves CHANGELOG.md unchanged.
  2. Run uv run cz bump --dry-run --yes --increment patch and confirm the configured changelog-enabled bump is previewed.
  3. Run uv run pytest -q tests/commands/test_bump_command.py tests/commands/test_changelog_command.py.
  4. Run uv run prek run check-yaml --files .github/workflows/bumpversion.yml.

Additional Context

The regression was introduced in PR #1924 by commit 97fb356d, which replaced commitizen-action (defaulting to --changelog) with a direct cz bump --yes invocation without the equivalent configuration.

@codecov

codecov Bot commented Aug 20, 2026 •
edited
Loading

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 98.26%. Comparing base (d910b66) to head (c391d9d).
⚠️ Report is 3 commits behind head on master.
✅ All tests successful. No failed tests found.

Additional details and impacted files 
@@           Coverage Diff           @@
##           master    #2074   +/-   ##
=======================================
  Coverage   98.26%   98.26%           
=======================================
  Files          61       61           
  Lines        2829     2829           
=======================================
  Hits         2780     2780           
  Misses         49       49

☔ View full report in Codecov by Harness.
📢 Have feedback on the report? Share it here.

@bearomorphism bearomorphism changed the title fix(ci): restore changelog updates ci: restore changelog updates Aug 20, 2026
@bearomorphism
ci: restore changelog updates
c391d9d 
Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
@bearomorphism
bearomorphism force-pushed the bearomorphism-fix-changelog-pipeline branch from 54387b0 to c391d9d Compare August 20, 2026 15:30
woile
woile reviewed Aug 20, 2026
View reviewed changes
Comment thread .github/workflows/bumpversion.yml Outdated
Comment thread pyproject.toml
@bearomorphism
ci: configure changelog updates on bump
0895592 
Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
@bearomorphism

bearomorphism commented Aug 20, 2026

Copy link
Copy Markdown
Collaborator Author

Thanks for quick review! (I'm still reading the root cause analysis from AI)

bearomorphism
bearomorphism commented Aug 20, 2026
View reviewed changes
Comment thread AGENTS.md
@bearomorphism
bearomorphism marked this pull request as ready for review August 20, 2026 15:47
@github-actions

github-actions Bot commented Aug 20, 2026

Copy link
Copy Markdown
Contributor

🔍 Commitizen bump preview

No commits in this PR are eligible for a version bump.

@bearomorphism
bearomorphism merged commit d24a56e into master Aug 20, 2026
20 checks passed
@bearomorphism
bearomorphism deleted the bearomorphism-fix-changelog-pipeline branch August 20, 2026 15:48
vemilano pushed a commit to vemilano/commitizen that referenced this pull request Aug 24, 2026
@bearomorphism @vemilano
ci: restore changelog updates (commitizen-tools#2074)
0bc70e8 
* ci: restore changelog updates

Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>

* ci: configure changelog updates on bump

Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>

---------

Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
@bearomorphism bearomorphism mentioned this pull request Sep 13, 2026
Closed
7 tasks done
bearomorphism added a commit that referenced this pull request Sep 14, 2026
@bearomorphism
fix(changelog): allow --no-incremental to override changelog_incremen…
3449f6d 
…tal config

The "Bump version" workflow's release-notes step runs
`cz changelog --dry-run "${NEW_VERSION}"`, passing the new version as a
positional rev_range. Since pyproject.toml sets `changelog_incremental = true`
(#2074), this combination now always raises
"--incremental cannot be combined with a rev_range", failing every release.

There was previously no way to override a config-enabled
`changelog_incremental` back to false from the CLI, since `--incremental` was
a plain store_true flag defaulting to False.

- Change `--incremental` to use argparse.BooleanOptionalAction (default None),
  adding a `--no-incremental` flag.
- CLI flag now takes precedence over the `changelog_incremental` config
  setting; falls back to config only when neither flag is passed.

Note: `.github/workflows/bumpversion.yml` still needs to be updated to pass
`--no-incremental` in its release-notes step, but that change requires the
`workflow` OAuth scope and is left for a follow-up/maintainer to apply.

`cz bump`'s internal changelog call already hardcodes incremental=True, so it
is unaffected by this change.

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
@bearomorphism bearomorphism mentioned this pull request Sep 14, 2026
Merged
2 tasks done
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@woile woile woile approved these changes

Assignees

No one assigned

Labels

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

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@bearomorphism @woile