-
Notifications
You must be signed in to change notification settings - Fork 25
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
✨ Release Notes Tooling & PR Verifier #2
✨ Release Notes Tooling & PR Verifier #2
Conversation
He's into release tooling stuff and his work is going into this repo.
This adds in a release notes composer that's based on controller-runtime's `hack/release/` tooling & the subsequent cluster-api release tooling written by vincepri, whence it draws pretty heavily.
This adds an actions verifier framework that makes it easy to run various checks against a pull request title/description, and send rich checks API results to GitHub.
This adds a github action that verifies PR titles according to the release notes rules, and verifies a couple of basic PR descriptiveness checks. It's automatically run on this repository.
[APPROVALNOTIFIER] This PR is APPROVED This pull-request has been approved by: DirectXMan12 The full list of commands accepted by this bot can be found here. The pull request process is described here
Needs approval from an approver in each of these files:
Approvers can indicate their approval by writing |
NB: once this is merged, it'll start running against this repo -- for security reasons, the action runs against the HEAD of the base branch, not the PR. /assign @vincepri for review |
(yes, I made this way more complicated, but it also does a bit more stuff automatically, like figuring out how to look back releases, sync upstreams, etc). |
This looks great, I took a quick glance and ready to merge it, going to do a small pass later today and LGTM it unless there is anything that stands out |
/lgtm !! thank you for doing this 🎉 I'll make sure to open some issues / PRs to use these tools in CAPI |
This adds a release notes composer based off of CR's hack/release scripts & the subsequent cluster-api Go release notes tooling by vincepri, whence it borrow heavily.
It lives in
notes/
, and includes both common utilities for reuse in various packages, as well as a common tool at the base that tries to figure out the situation mostly on its own.This also adds a framework for running basic PR checks in Go, running them in GitHub actions, and writing the results. We make use of this framework to add a GitHub action at the root of this repository that verifies the PR title for release notes and checks that the PR description meets some basic descriptiveness standards.
The actions-related code lives in
verify/
, with the action's main inverify/cmd
(see the Dockerfile at the root).