Skip to content

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

@ttak0422

Description

@ttak0422

Problem

The release workflow currently regenerates CHANGELOG.md and commits it directly to the default branch in the Commit and push CHANGELOG.md step.

This conflicts with the repository rule that changes should be committed through a pull request rather than pushed directly.

Workflow reference:

  • .github/workflows/release.yml
  • step: Commit and push CHANGELOG.md

Current behavior

On tag push, the workflow checks out the default branch, regenerates CHANGELOG.md, commits it, and pushes it directly:

git add CHANGELOG.md
git commit -m "chore(release): update CHANGELOG.md"
git push origin ${{ github.event.repository.default_branch }}

Expected behavior

The release process should avoid direct commits to the default branch.
Possible approaches:

  • open a PR with the regenerated CHANGELOG.md
  • move changelog regeneration to a separate PR-based workflow
  • stop mutating the default branch during release

Why this matters

  • violates the repository's PR-first change policy
  • can bypass normal review and CI expectations
  • makes release automation inconsistent with the rest of the development flow

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions