-
-
Notifications
You must be signed in to change notification settings - Fork 1.7k
ci: Add workflow to automatically add external contributors to CHANGELOG.md #12428
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
Conversation
2934ab3
to
e0b32ad
Compare
This reverts commit b0c4a8a.
666087e
to
7f4a720
Compare
runs-on: ubuntu-20.04 | ||
if: | | ||
github.event_name == 'pull_request' | ||
&& (github.action == 'opened' || github.action == 'reopened') |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
do not run this on each update, as it is kind of wasteful (it should not actually error, just unnecessary computation)
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looking at the example PR, shouldn't the workflow have appended the new contributor to the already mentioned one? We could also just keep a list of contributors in the ##Unreleased section to simplify the appending process
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Regardless, I'm fine with either way, as long as we don't by default overwrite already mentioned contributors 😅
It should! I forced it to only add a single entry to test how it looks (I manually removed it in the changelog) |
I added some logic to handle this, hopefully. It's regex-y, but I tested the different scenarios and it should work to append stuff correctly if it exsits! |
This adds a new GHA job that, if a PR is created by an external contributor, it will open a PR against that branch that adds the contributor to the changelog, so we do not forget about this.
It will open a PR like this:
#12435
which we have to manually merge/review, so nothing "bad" can happen.