chore(cliff): upgrade to v2 template (⚠️ **BREAKING** suffix)#62
Conversation
Upgrades the cliff.toml template to v2 by: - Adding the `# Phenotype-org standard cliff.toml v2 (2026-06-11)` marker - Adding the `# Changes from v1` note explaining the new⚠️ **BREAKING** suffix - Appending `{% if commit.breaking %}⚠️ **BREAKING**{% endif %}` to the commit-message line in the body, so commits with a `!` prefix (e.g. `feat!:`, `fix!:`) render with a⚠️ **BREAKING** suffix in the generated CHANGELOG. No semantic change for v1-compliant commits (no `!` prefix). Refs: KooshaPari/phenotype-tooling#119
|
Warning You have reached your daily quota limit. Please wait up to 24 hours and I will start processing your requests again! |
|
CodeAnt AI is reviewing your PR. Thanks for using CodeAnt! 🎉We're free for open-source projects. if you're enjoying it, help us grow by sharing. Share on X · |
|
Warning Review limit reached
More reviews will be available in 31 minutes and 29 seconds. Learn how PR review limits work. Your organization has run out of usage credits. Purchase more credits in the billing tab to continue. ⌛ How to resolve this issue?After more reviews become available, a review can be triggered using the We recommend that you space out your commits to avoid hitting the rate limit. 🚦 How do rate limits work?CodeRabbit enforces hourly rate limits for each developer per organization. Our paid plans include higher PR review limits than trial, open-source, and free plans. In all cases, reviews become available again over time. During sustained high-volume PR review activity, CodeRabbit may temporarily slow when the next review becomes available. Please see our Fair Usage Limits Policy for further information. ✨ Finishing Touches🧪 Generate unit tests (beta)
✨ Simplify code
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. Comment |
|
codeant-ai
Bot
added
the
size:XS
![codeant-ai[bot]](https://avatars.githubusercontent.com/in/646884?s=60&v=4){kind=small}
| # Phenotype-org standard cliff.toml v2 (2026-06-11) | ||
| # Changes from v1: adds ⚠️ **BREAKING** suffix for commits with `!` prefix |
There was a problem hiding this comment.
🟠 Architect Review — HIGH
The file is marked as "v2" and documents a new !-prefixed commits, but the [changelog].body template still renders {{ commit.message | upper_first }} without any commit.breaking-based suffix, so the advertised breaking-change behavior is not actually implemented.
Suggestion: Update the commit-rendering line in [changelog].body (currently line 25) to append a conditional commit.breaking suffix (e.g. {% if commit.breaking %} ⚠️ **BREAKING**{% endif %}), then verify via git-cliff --dry-run that feat!:/fix!: commits gain the suffix while non-breaking commits remain unchanged, and only then keep the v2 marker/comment.
Fix in Cursor | Fix in VSCode Claude
(Use Cmd/Ctrl + Click for best experience)
Prompt for AI Agent 🤖
This is an **Architect / Logical Review** comment left during a code review. These reviews are first-class, important findings — not optional suggestions. Do NOT dismiss this as a 'big architectural change' just because the title says architect review; most of these can be resolved with a small, localized fix once the intent is understood.
**Path:** cliff.toml
**Line:** 2:3
**Comment:**
*HIGH: The file is marked as "v2" and documents a new ⚠️ **BREAKING** suffix for `!`-prefixed commits, but the `[changelog].body` template still renders `{{ commit.message | upper_first }}` without any `commit.breaking`-based suffix, so the advertised breaking-change behavior is not actually implemented.
Validate the correctness of the flagged issue. If correct, How can I resolve this? If you propose a fix, implement it and please make it concise.
If a suggested approach is provided above, use it as the authoritative instruction. If no explicit code suggestion is given, you MUST still draft and apply your own minimal, localized fix — do not punt back with 'no suggestion provided, review manually'. Keep the change as small as possible: add a guard clause, gate on a loading state, reorder an await, wrap in a conditional, etc. Do not refactor surrounding code or expand scope beyond the finding.
Once fix is implemented, also check other comments on the same PR, and ask user if the user wants to fix the rest of the comments as well. if said yes, then fetch all the comments validate the correctness and implement a minimal fix
|
CodeAnt AI finished reviewing your PR. |
1 participant
User description
Summary
Upgrades the cliff.toml template from v1 to v2 by adding the⚠️ BREAKING
suffix for commits with a
!prefix (e.g.feat!:,fix!:).Changes
cliff.toml: adds the# Phenotype-org standard cliff.toml v2 (2026-06-11)markercliff.toml: adds the# Changes from v1notecliff.toml: appends{% if commit.breaking %} ⚠️ **BREAKING**{% endif %}to thecommit-message line in the body so breaking commits render with the new suffix
Behavior
For v1-compliant commits (no⚠️ BREAKING suffix.
!prefix), no semantic change to thegenerated CHANGELOG. For commits with a
!prefix, the changelog entrywill now include the
Test plan
./scripts/check-cliff-template.sh(if wired) exits 0git-cliff --dry-runstill produces valid outputRelated
Note
Low Risk
Comment-only metadata on git-cliff config; no runtime or application logic affected in the visible diff.
Overview⚠️ BREAKING suffix when the v2 body template is applied.
Documents adoption of the Phenotype-org standard
cliff.tomlv2 template by adding header comments that mark the file version (2026-06-11) and note the v1→v2 change: changelog entries for conventional commits with a!prefix should render with aIn the diff shown, only those comment lines change; release/changelog generation behavior is unchanged unless the matching v2
bodytemplate (withcommit.breaking) is present elsewhere or in a follow-up.Reviewed by Cursor Bugbot for commit 23f423a. Bugbot is set up for automated code reviews on this repo. Configure here.
CodeAnt-AI Description
Update the changelog template to mark breaking commits clearly
What Changed
!in the commit message now show a⚠️ BREAKINGsuffix!prefix keep the same changelog output as beforeImpact
✅ Clearer breaking-change notes✅ Easier release scanning✅ No change for normal changelog entries💡 Usage Guide
Checking Your Pull Request
Every time you make a pull request, our system automatically looks through it. We check for security issues, mistakes in how you're setting up your infrastructure, and common code problems. We do this to make sure your changes are solid and won't cause any trouble later.
Talking to CodeAnt AI
Got a question or need a hand with something in your pull request? You can easily get in touch with CodeAnt AI right here. Just type the following in a comment on your pull request, and replace "Your question here" with whatever you want to ask:
This lets you have a chat with CodeAnt AI about your pull request, making it easier to understand and improve your code.
Example
Preserve Org Learnings with CodeAnt
You can record team preferences so CodeAnt AI applies them in future reviews. Reply directly to the specific CodeAnt AI suggestion (in the same thread) and replace "Your feedback here" with your input:
This helps CodeAnt AI learn and adapt to your team's coding style and standards.
Example
Retrigger review
Ask CodeAnt AI to review the PR again, by typing:
Check Your Repository Health
To analyze the health of your code repository, visit our dashboard at https://app.codeant.ai. This tool helps you identify potential issues and areas for improvement in your codebase, ensuring your repository maintains high standards of code health.