Conversation
shamykyzer
commented
Feb 26, 2026
- Add Changelog CI workflow for release PRs
- Reformat generated changelog to match existing style (version date, bullet format)
- Add changelog-ci config and reformat script
- Update CONTRIBUTING: changelog auto-generated, document release workflow
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #352 +/- ##
=======================================
Coverage 99.70% 99.70%
=======================================
Files 9 9
Lines 1348 1348
=======================================
Hits 1344 1344
Misses 4 4 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
|
Hello @rpreen , i looked into it and Commitizen didn’t feel like the right fit here because it’s commit based and mainly release time focused. Since we want PR title based entries, i went with Changelog CI plus a small reformatter as it matched the repo policy and will keep the versioning and the release process unchanged. Also I couldn't continue this development further due to the bot not having write permissions I think. Let me know what you think and where I can go from here. 👍🏼 |
|
I think this is a more complicated solution than we need. If I understand correctly, any time someone opens a PR the bot will push a new commit onto their branch, which they will probably not expect or appreciate. Their local branch will then be behind, so they will have to do a pull before they can make any further commits. If multiple PRs are opened simultaneously both will modify the changelog in the same location causing a merge conflict. I think for us we need a simpler solution that only runs before a release - I just added a comment on #327 about this. |
44174ea to
8d891c6
Compare
- Add Changelog CI workflow for release PRs - Reformat generated changelog to match existing style (version date, bullet format) - Add changelog-ci config and reformat script - Update CONTRIBUTING: changelog auto-generated, document release workflow
for more information, see https://pre-commit.ci
for more information, see https://pre-commit.ci
for more information, see https://pre-commit.ci
8d891c6 to
641c9d3
Compare
@rpreen could you try running the script and tell me what you think? I am more than glad to add more commands such as for updating the version or implementing it in github actions .yml only when push if you change your mind! |
|
I have:
this now needs checking and potentially tweaking the contributing guide and |