Skip to content

#273 ci: retire changelog-refresh cron, release-plz is the single changelog writer - #274

Merged
RAprogramm merged 1 commit into
mainfrom
273
Aug 24, 2026
Merged

#273 ci: retire changelog-refresh cron, release-plz is the single changelog writer#274
RAprogramm merged 1 commit into
mainfrom
273

Conversation

@RAprogramm

@RAprogramm RAprogramm commented Aug 24, 2026

Copy link
Copy Markdown
Owner

Closes #273

Two automations were writing to CHANGELOG.md: the weekly changelog-refresh.yml cron (git-cliff regenerating ## [Unreleased] via a GITHUB_TOKEN PR that never gets CI) and release-plz (release PR with the version bump and a curated ## [x.y.z] section from the same commits). The cron added nothing the release PR does not already show and left a duplicated ### CI block in [0.12.5].

Following the single release-PR model:

  • delete .github/workflows/changelog-refresh.yml
  • update the Changelog job comment in ci.yml (the run-summary preview stays; it is read-only)
  • remove the duplicated cron-generated block from the [0.12.5] section

The empty ## [Unreleased] anchor stays as Keep a Changelog recommends; release-plz inserts new versions beneath it. #256 will be closed without merging once this lands.

Verified locally: actionlint, zizmor (no new findings), git-cliff still renders the Unreleased preview.

Summary by CodeRabbit

  • Chores
    • Removed the automated weekly changelog refresh workflow.
    • Updated CI changelog previews to clarify that release pull requests write changelog updates.
    • Refined the version 0.12.5 changelog entry to improve dependency update formatting.

@RAprogramm
RAprogramm enabled auto-merge (squash) August 24, 2026 02:33
@coderabbitai

coderabbitai Bot commented Aug 24, 2026

Copy link
Copy Markdown

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro Plus

Run ID: d0a7753d-bf37-486d-bfe8-4394288ddead

📥 Commits

Reviewing files that changed from the base of the PR and between 5bb3c44 and 84b4673.

📒 Files selected for processing (3)
  • .github/workflows/changelog-refresh.yml
  • .github/workflows/ci.yml
  • CHANGELOG.md
💤 Files with no reviewable changes (2)
  • CHANGELOG.md
  • .github/workflows/changelog-refresh.yml

Included review availability: Your plan provides up to 10 included reviews per hour; 6 remain after this review.


📝 Walkthrough

Walkthrough

The weekly changelog refresh workflow was deleted. CI comments now identify release-plz as the changelog writer. The duplicated cron-generated entry was removed from the 0.12.5 changelog section.

Changes

Changelog writer consolidation

Layer / File(s) Summary
Release-plz changelog flow
.github/workflows/changelog-refresh.yml, .github/workflows/ci.yml, CHANGELOG.md
The weekly changelog workflow was deleted. CI comments now reference release-plz release PRs. The duplicate 0.12.5 CI entry was removed.

Estimated code review effort: 2 (Simple) | ~10 minutes

Merge Risk: ⚪ Minimal · up to 84b46

This change makes release-plz the sole changelog writer while retaining the read-only preview and removing duplicated changelog content; no actionable merge-blocking risk remains after normal checks and review.

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title clearly identifies the retirement of the changelog-refresh cron and the move to release-plz as the sole changelog writer.
Linked Issues check ✅ Passed The changes satisfy all coding requirements in issue #273, including workflow deletion, comment cleanup, and removal of the duplicated changelog block.
Out of Scope Changes check ✅ Passed All changes support issue #273 and remain within scope; no unrelated code or configuration changes are present.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff. Analyzed 0 functions across 0 files. (1 skipped: 1 unsupported.)
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch 273

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

@codecov

codecov Bot commented Aug 24, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.

📢 Thoughts on this report? Let us know!

@RAprogramm
RAprogramm merged commit 72d67b8 into main Aug 24, 2026
37 checks passed
@RAprogramm
RAprogramm deleted the 273 branch August 24, 2026 02:35
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.

Retire the changelog-refresh cron: release-plz is the single changelog writer

1 participant