Skip to content

ci: added git-cliff changelog automation#49

Merged
rpreen merged 7 commits into
mainfrom
ci-automate-updating-changelogs
May 20, 2026
Merged

ci: added git-cliff changelog automation#49
rpreen merged 7 commits into
mainfrom
ci-automate-updating-changelogs

Conversation

@shamykyzer
Copy link
Copy Markdown
Contributor

@shamykyzer shamykyzer commented Mar 23, 2026

Closes #41.

Adds git-cliff changelog automation. NEWS.md entries are generated from
Conventional-Commits PR titles, run locally by the release manager before tagging.

  • cliff.toml: git-cliff config (groups by type, filters to V* tags, links (#NNN) to PRs, skips noise).
  • CONTRIBUTING.md: documents the PR-title convention and release command.
  • .Rbuildignore: excludes cliff.toml from the package tarball.

@shamykyzer shamykyzer self-assigned this Mar 23, 2026
@shamykyzer shamykyzer linked an issue Mar 23, 2026 that may be closed by this pull request
@codecov
Copy link
Copy Markdown

codecov Bot commented Mar 23, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 100.00%. Comparing base (51810ca) to head (75e47e9).

Additional details and impacted files
@@            Coverage Diff            @@
##              main       #49   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files            4         4           
  Lines          115       115           
=========================================
  Hits           115       115           

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

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

@shamykyzer shamykyzer marked this pull request as ready for review April 2, 2026 11:57
@shamykyzer
Copy link
Copy Markdown
Contributor Author

Hello @rpreen, could you have a look at this and let me know what you think?

@shamykyzer shamykyzer requested review from JessUWE and rpreen April 2, 2026 11:58
@shamykyzer shamykyzer force-pushed the ci-automate-updating-changelogs branch 2 times, most recently from b903593 to 7e29096 Compare April 2, 2026 12:18
@shamykyzer shamykyzer force-pushed the ci-automate-updating-changelogs branch from 14bb6c5 to f0de8ea Compare April 2, 2026 12:40
@rpreen
Copy link
Copy Markdown
Collaborator

rpreen commented Apr 28, 2026

I just took a quick look at this and I think the config needs tweaking - if you look at the toml in the Python ACRO repo I made some changes before it was merged - in particular there needs to be a default fall through with category 'other' to handle the cases where someone has merged/committed to the main branch without using conventional commits.

shamykyzer and others added 2 commits April 29, 2026 21:05
Apply Richard's review on PR #49.

cliff.toml:
- Set filter_unconventional to false and add a final ".*" parser
  that groups leftover commits under "Other".
- Rename group labels to readable names (Features, Bug Fixes, etc.).
- Add preprocessors that strip Signed-off-by trailers and multi-line
  commit bodies, so each entry is one tidy subject line.
- Set trim to false so a blank line separates each release.

CONTRIBUTING.md:
- Update the cliff.toml summary to describe the new "Other" behavior.

Repo-specific bits kept: uppercase V tag pattern, ACRO-R PR URL.
@shamykyzer
Copy link
Copy Markdown
Contributor Author

Hi @rpreen, could you please have a look at my changes? I can't seem to pass the macOS CI check either..

@JessUWE
Copy link
Copy Markdown
Contributor

JessUWE commented May 12, 2026

@shamykyzer Can you look through our stand-up notes and see if any of the suggestions would help.

@shamykyzer
Copy link
Copy Markdown
Contributor Author

shamykyzer commented May 12, 2026

Again, sorry @JessUWE for not checking the stand-up notes, this should be good to merge now.

I switched to reticulate's own Python resolver instead of blindly picking the first python3 in PATH, which was failing on conda runners.

Before:

python <- get_python()

After:

python <- reticulate::virtualenv_starter()
if (is.null(python)) python <- get_python()

@jim-smith
Copy link
Copy Markdown
Collaborator

Again, sorry @JessUWE for not checking the stand-up notes, this should be good to merge now.

I switched to reticulate's own Python resolver instead of blindly picking the first python3 in PATH, which was failing on conda runners.

Before:

python <- get_python()

After:

python <- reticulate::virtualenv_starter()
if (is.null(python)) python <- get_python()

@shamykyzer need to check this logic (using reticulate's resolver), because 'it's hard to install the R version" is a really common complaint from TREs.

We need to make sure that we pick up the version of python that has acro installed - this will/should be in a virtual environment of its own, and that env should be pushed to the front of PATH - but all the relevant info should be in the installation / help guides

@shamykyzer
Copy link
Copy Markdown
Contributor Author

As discussed in the meeting, this PR should be ready for merge now

@jim-smith
Copy link
Copy Markdown
Collaborator

@rpreen sorry -this is a 2-3 minute ask, related to the work you did on making the R-python setup more robust.

@shamykyzer had put in a fix that made the conda macOS runner work - see above- it's currently reverted but we could put it back im. Could you have a look and see what you think.

Copy link
Copy Markdown
Collaborator

@rpreen rpreen left a comment

Choose a reason for hiding this comment

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

the macOS runner failure is another issue not caused by anything here

@rpreen rpreen merged commit 50c6fc1 into main May 20, 2026
12 of 13 checks passed
@rpreen rpreen deleted the ci-automate-updating-changelogs branch May 20, 2026 10:53
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.

[ci] automate updating changelog from PR names

4 participants