Skip to content

build: add git-cliff for automated changelog and release notes#421

Merged
DamianCzajkowski merged 1 commit intomainfrom
git-cliff
Mar 13, 2026
Merged

build: add git-cliff for automated changelog and release notes#421
DamianCzajkowski merged 1 commit intomainfrom
git-cliff

Conversation

@DamianCzajkowski
Copy link
Copy Markdown
Collaborator

Summary

  • Integrates git-cliff into the release workflow to auto-generate GitHub release notes during prepare_release.
  • Adds a dedicated cliff.toml with conventional-commit grouping, stable-tag filtering, and release/changelog templates.
  • Simplifies CHANGELOG.md to an unreleased template and shifts released-version history to GitHub Releases.
  • Adds hatch shortcuts in pyproject.toml for local changelog/release-note generation:
    • changelog-preview
    • changelog-update
    • release-notes

Why

  • Reduces manual release work and keeps release notes consistent.
  • Makes changelog generation reproducible in CI and locally.
  • Standardizes commit categorization and formatting for better readability.

@coderabbitai
Copy link
Copy Markdown

coderabbitai bot commented Mar 13, 2026

Important

Review skipped

Auto reviews are disabled on this repository. Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: 50158875-8235-40b6-bc56-4d79e8bd7e53

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Use the checkbox below for a quick retry:

  • 🔍 Trigger review
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch git-cliff
📝 Coding Plan
  • Generate coding plan for human review comments

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

Tip

CodeRabbit can use OpenGrep to find security vulnerabilities and bugs across 17+ programming languages.

OpenGrep is compatible with Semgrep configurations. Add an opengrep.yml or semgrep.yml configuration file to your project to enable OpenGrep analysis.

@DamianCzajkowski DamianCzajkowski merged commit 8f97602 into main Mar 13, 2026
6 checks passed
@DamianCzajkowski DamianCzajkowski deleted the git-cliff branch March 13, 2026 12:13
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.

2 participants