Skip to content

Split release prep from tag release#22

Merged
ttak0422 merged 2 commits intomainfrom
fix/release-changelog-pr-workflow
Mar 29, 2026
Merged

Split release prep from tag release#22
ttak0422 merged 2 commits intomainfrom
fix/release-changelog-pr-workflow

Conversation

@ttak0422
Copy link
Copy Markdown
Owner

@ttak0422 ttak0422 commented Mar 29, 2026

Summary

  • add a separate release-prep.yml workflow that creates a release preparation PR from a manually supplied version
  • simplify release.yml so tag pushes only create the GitHub Release and do not mutate the repository
  • keep CHANGELOG.md updates on the normal PR review path instead of generating them after release

Release flow after this change

  1. Run release-prep.yml with a version like 0.2.4
  2. Review and merge the generated release prep PR
  3. Tag the resulting merge commit as v0.2.4
  4. Let release.yml create the GitHub Release from that tag

Why

The previous release workflow still treated changelog updates as a post-release concern. That avoided direct pushes to the default branch, but it kept the release pipeline split across tagging and a follow-up changelog PR.

This change makes main the source of truth for release metadata before tagging, which is more consistent with a PR-first repository policy.

Closes #19

Testing

  • reviewed workflow YAML locally
  • verified git-cliff --tag vX.Y.Z --output CHANGELOG.md behavior locally

@ttak0422 ttak0422 changed the title Create PR for release changelog updates Split release prep from tag release Mar 29, 2026
@ttak0422 ttak0422 merged commit 8e34e82 into main Mar 29, 2026
2 checks passed
@ttak0422 ttak0422 deleted the fix/release-changelog-pr-workflow branch March 29, 2026 15:33
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.

release.yml updates CHANGELOG.md directly on the default branch

1 participant