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.md entry checker to GHA workflows #500

Merged
merged 1 commit into from
Apr 15, 2021
Merged

Conversation

therealprof
Copy link
Contributor

@therealprof therealprof commented Apr 13, 2021

r? @adamgreig

Signed-off-by: Daniel Egger daniel@eggers-club.de

@rust-highfive
Copy link

r? @ryankurte

(rust-highfive has picked a reviewer for you, use r? to override)

@rust-highfive rust-highfive added S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. T-tools labels Apr 13, 2021
@@ -0,0 +1,19 @@
on:
pull_request_target:
Copy link
Member

Choose a reason for hiding this comment

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

Does it need to be pull_request_target? On the example for the action they seem to just use a normal pull_request.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Not sure, it's a verbatim copy from the stm32f4xx-hal. 🤷🏻‍♂️

Copy link
Member

Choose a reason for hiding this comment

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

Could you try with just pull_request? If that works it's somewhat more straightforward and safer.

@adamgreig
Copy link
Member

Thanks, looks like it works. Currently it won't stop bors at all (if I bors+ this now, it should merge, I think) because it doesn't run on bors' push to staging and also bors isn't configured to care about it. I think this sort of makes sense - it should alert reviewers/users that the changelog is missing, but doesn't stop a change being r+'d if the reviewer thinks it's fine. I don't think the "apply label to allow it to pass without changelog" would work under bors anyway, so this is probably the best config. What do you think? Happy to merge as-is.

adamgreig
adamgreig previously approved these changes Apr 14, 2021
Signed-off-by: Daniel Egger <daniel@eggers-club.de>
@adamgreig
Copy link
Member

Oh, sorry, I didn't notice the force push. What did you change?

Copy link
Member

@adamgreig adamgreig left a comment

Choose a reason for hiding this comment

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

bors merge

@therealprof
Copy link
Contributor Author

As requested I changed pull_request_target to pull_request.

@therealprof
Copy link
Contributor Author

I don't think the "apply label to allow it to pass without changelog" would work under bors anyway, so this is probably the best config. What do you think? Happy to merge as-is.

I agree. Alerting the reviewer to a missing CHANGELOG entry should be okay.

@bors bors bot merged commit 843475e into master Apr 15, 2021
@bors bors bot deleted the check-changelog branch April 15, 2021 00:25
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. T-tools
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants