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 GitHub Actions to check pull requests for release notes #2006

Merged

Conversation

kylemhall
Copy link
Member

Some developers ahem seem to have a hard time remembering to add release notes to their branches.

This branch adds a new GitHub actions file that will run only for pull requests.
It will check to see if this branch contains any changes to a release notes file.
If no changes are found, the action will fail alerting the author to the problem.

Some developers *ahem* seem to have a hard time remembering to add release notes to their branches.

This branch adds a new GitHub actions file that will run only for pull requests.
It will check to see if this branch contains any changes to a release notes file.
If no changes are found, the action will fail alerting the author to the problem.

Test Plan:
1) Cherry-pick this to a new branch
2) Add a commit that changes something but not the release notes
3) Push this branch to GitHub
4) Create a pull request for that branch
5) Note the action fails
6) Add another commit updating the release notes
7) Push this updated branch
8) Note the action passes!
@kylemhall
Copy link
Member Author

You can actually see this in action on the pull request!
Failure: https://github.com/Aspen-Discovery/aspen-discovery/actions/runs/10493499597/job/29067607651?pr=2006

@kylemhall
Copy link
Member Author

@tomascohen
Copy link
Contributor

I love this kind of automation.

@mdnoble73 mdnoble73 merged commit fbd9aab into Aspen-Discovery:24.09.00 Aug 21, 2024
1 check failed
@kylemhall kylemhall deleted the github_actions_release_notes branch August 30, 2024 10:46
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.

3 participants