Skip to content

chore: remove update-readme-on-release workflow#34

Merged
mmonterroca merged 1 commit into
masterfrom
chore/remove-readme-release-workflow
May 1, 2026
Merged

chore: remove update-readme-on-release workflow#34
mmonterroca merged 1 commit into
masterfrom
chore/remove-readme-release-workflow

Conversation

@mmonterroca

Copy link
Copy Markdown
Owner

Why

The update-readme-on-release.yml workflow attempted to auto-create a PR after each release to bump README version metadata. It failed on v2.4.0 with:

GitHub Actions is not permitted to create or approve pull requests.

Decision: remove rather than fix

  • README is already updated as part of the release PR (version, date, features, roadmap, CHANGELOG). The workflow only duplicated 2 lines (**Current Version** and **Released**).
  • Enabling the org-wide "Allow GitHub Actions to create and approve pull requests" permission widens the supply-chain attack surface for purely cosmetic gain.
  • A PAT-based fix adds maintenance overhead (rotation, scope) for the same low-value task.

Process going forward

The release SOP stays inside the release PR (manual, reviewed):

  1. Branch release/vX.Y.Z from master
  2. Merge feature/fix branches
  3. Bump version in doc.go, README.md, docs/V2_*.md
  4. Update CHANGELOG.md + RELEASE_NOTES_vX.Y.Z.md
  5. PR → review → CI → merge
  6. git tag + gh release create
  7. Comment on closed issues with link to release

The workflow attempted to auto-create a PR after each release to bump
README version metadata, but:

- README is already updated as part of the release PR (version, date,
  features, roadmap, CHANGELOG) — workflow only duplicated 2 lines.
- Default GITHUB_TOKEN cannot create PRs; enabling that org-wide
  permission widens the supply-chain attack surface for cosmetic gain.
- Latest run failed for v2.4.0 with:
  'GitHub Actions is not permitted to create or approve pull requests.'

Release process going forward stays manual inside the release PR.
@gemini-code-assist

Copy link
Copy Markdown

Note

Gemini is unable to generate a review for this pull request due to the file types involved not being currently supported.

@mmonterroca mmonterroca merged commit 6b1de1a into master May 1, 2026
5 checks passed
@mmonterroca mmonterroca deleted the chore/remove-readme-release-workflow branch May 1, 2026 05:08
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.

1 participant