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: add new GH actions to require release note updates #5520

Merged

Conversation

Roasbeef
Copy link
Member

In this commit, we add a simple bash script to parse out the current PR
number from an environment variable in the GH actions context, and use
that to check to see if the PR has been referenced in the release notes
or not. This isn't 100% fool proof, but it should catch most of the
common cases.

@Roasbeef Roasbeef added this to the v0.14.0 milestone Jul 14, 2021
@guggero
Copy link
Collaborator

guggero commented Jul 15, 2021

Uuuh, nice!

The check is currently failing with scripts/check-release-notes.sh: No such file or directory. Do you need to run a chmod +x on the file to make it executable?

@guggero guggero self-requested a review July 15, 2021 07:53
@Roasbeef
Copy link
Member Author

The check is currently failing with scripts/check-release-notes.sh: No such file or directory. Do you need to run a chmod +x on the file to make it executable?

Doubled checked and it's executable in my local branch. I think maybe it's that the file isn't yet committed by the time the final commit is run? Gonna try to commit the file in the first commit, and use it in the second.

@Roasbeef
Copy link
Member Author

Or actually, I'll just add a commit that adds this change to the release notes, that way we can verify it passes properly.

Copy link
Collaborator

@guggero guggero left a comment

Choose a reason for hiding this comment

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

Seems to not be running because of the missing git checkout in the workflow step.

Tested this locally and can confirm it works correctly.
Only thing is: This will make it necessary to submit the PR first and then add the release notes once you know what PR number you get. But I guess that's inevitable...

.github/workflows/main.yml Show resolved Hide resolved
.github/workflows/main.yml Outdated Show resolved Hide resolved
In this commit, we add a simple bash script to parse out the current PR
number from an environment variable in the GH actions context, and use
that to check to see if the PR has been referenced in the release notes
or not. This isn't 100% fool proof, but it should catch most of the
common cases.
@Roasbeef Roasbeef force-pushed the actions-require-release-notes branch from 9f80eba to 1219795 Compare July 16, 2021 18:01
@Roasbeef
Copy link
Member Author

@guggero thanks for the additional pass! Looks like that did it.

This will make it necessary to submit the PR first and then add the release notes once you know what PR number you get. But I guess that's inevitable...

Yeah not sure if there's a good way around that....

@Roasbeef Roasbeef merged commit 7176a21 into lightningnetwork:master Jul 16, 2021
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.

None yet

2 participants