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

Add changelog verifier #13909

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

stefanvodita
Copy link
Contributor

@stefanvodita stefanvodita commented Oct 14, 2024

Description

This runs along the checks we already have for PR creation/update and warns us if there is no CHANGES.txt entry.

Closes #13898

@jpountz
Copy link
Contributor

jpountz commented Oct 15, 2024

Is it possible to disable this check based on files that are touched (e.g. test-only fixes don't require a changelog entry) and based on the presence of a label (e.g. mechanical refactorings that have no user-facing impact don't need a changelog entry)?

@stefanvodita
Copy link
Contributor Author

Right now this would show up like a separate automated check on PRs, which would fail if the changelog is untouched and we don't have the Skip-Changelog label. We can override it in cases where we think a changelog entry is not required. To reduce noise from build failure emails, we can run it only for new PRs, once.

We could also make it smarter about the files that are changed in the PR. Useful example: https://fredrikmeyer.net/2021/05/12/github-actions-changelog.html

My preference would have been to make it a comment instead of a failing check, but I haven't found an action that checks file diffs and comments.

Copy link

This PR has not had activity in the past 2 weeks, labeling it as stale. If the PR is waiting for review, notify the [email protected] list. Thank you for your contribution!

@github-actions github-actions bot added the Stale label Oct 30, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Create a bot to check if there is a CHANGES entry for new PRs
2 participants