Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

build github action to verify changelog entries have been added #36344

Merged
merged 1 commit into from
Jan 17, 2025

Conversation

DanielMSchmidt
Copy link
Contributor

@DanielMSchmidt DanielMSchmidt commented Jan 16, 2025

This PR warns the user if they a) miss a changelog entry, b) miscategorize a changelog entry, c) the changelog has been manually edited outside a release.
It creates / updates / deletes a comment on the PR.

Fixes #

Target Release

1.11.x

CHANGELOG entry

  • This change is user-facing and I added a changelog entry.
  • This change is not user-facing.

@DanielMSchmidt DanielMSchmidt requested a review from a team as a code owner January 16, 2025 11:00
@DanielMSchmidt DanielMSchmidt added the no-changelog-needed Add this to your PR if the change does not require a changelog entry label Jan 16, 2025
@DanielMSchmidt DanielMSchmidt marked this pull request as draft January 16, 2025 11:46
repo,
})).data;

const existingComment = allComments.find(c => c.body.startsWith(commentStart));
Copy link
Member

Choose a reason for hiding this comment

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

if you wanted to be double sure, the response should also contain the user who made the comment. You could check that is the same user we're executing as now. We can always come back and add this if we find people do start writing comments that start with ## Changelog Warning

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Yeah, let's fix this if the need arises 👍 We will probably need to touch this script at some point again when new needs surface :)

@DanielMSchmidt DanielMSchmidt merged commit 3a3bea8 into main Jan 17, 2025
18 checks passed
@DanielMSchmidt DanielMSchmidt deleted the changelog-github-action branch January 17, 2025 09:29
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
no-changelog-needed Add this to your PR if the change does not require a changelog entry
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants