Skip to content

Add changelog validation workflow for release PRs - #28

Merged
njuettner merged 3 commits into
mainfrom
validate-changelog
Jun 26, 2025
Merged

Add changelog validation workflow for release PRs#28
njuettner merged 3 commits into
mainfrom
validate-changelog

Conversation

@njuettner

@njuettner njuettner commented Jun 25, 2025

Copy link
Copy Markdown
Member

Towards: https://github.com/giantswarm/giantswarm/issues/33613

Adds a GitHub Actions workflow to validate that release PRs contain proper changelog entries. The workflow:

  • Triggers on release branch patterns (#release#v1.2.3, #release#major/minor/patch)
  • Extracts version from branch name or changelog
  • Ensures changelog sections aren't empty
  • Comments on PR if validation fails

This prevents releases with missing or empty changelog content.

Example: giantswarm/cluster-api-events#34

image

@njuettner
njuettner force-pushed the validate-changelog branch from 5ef84aa to 4c9658f Compare June 25, 2025 07:09
@njuettner
njuettner marked this pull request as ready for review June 25, 2025 09:57
@njuettner
njuettner requested a review from a team as a code owner June 25, 2025 09:57
@njuettner
njuettner requested review from a team June 25, 2025 11:58
@@ -0,0 +1,200 @@
name: Validate Release Changelog

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Is this workflow usable in all repositories, or only in specific ones? The term "Release Changelog" makes me think that it's something specific. If it's any "keep-a-changelog" changelog, I'd rather change the title to something like "Validate changelog" or "Validate changelog structure".

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

Yep it's usable in all repos 👍🏻. I updated the title as suggested, it makes sense. I hope it's more clear now

@njuettner
njuettner merged commit 3681e34 into main Jun 26, 2025
1 check passed
@njuettner
njuettner deleted the validate-changelog branch June 26, 2025 09:25
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.

3 participants