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

✨ Release Notes Tooling & PR Verifier #2

Merged

Conversation

DirectXMan12
Copy link
Contributor

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 in verify/cmd (see the Dockerfile at the root).

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.
@k8s-ci-robot k8s-ci-robot added the cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. label Oct 1, 2020
@k8s-ci-robot
Copy link
Contributor

[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 /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@k8s-ci-robot k8s-ci-robot added approved Indicates a PR has been approved by an approver from all required OWNERS files. size/XXL Denotes a PR that changes 1000+ lines, ignoring generated files. labels Oct 1, 2020
@DirectXMan12
Copy link
Contributor Author

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

@DirectXMan12
Copy link
Contributor Author

(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).

@vincepri
Copy link
Member

vincepri commented Oct 1, 2020

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

@vincepri
Copy link
Member

vincepri commented Oct 1, 2020

/lgtm

!! thank you for doing this 🎉

I'll make sure to open some issues / PRs to use these tools in CAPI

@k8s-ci-robot k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Oct 1, 2020
@DirectXMan12 DirectXMan12 changed the title Release Notes Tooling & PR Verifier ✨ Release Notes Tooling & PR Verifier Oct 1, 2020
@k8s-ci-robot k8s-ci-robot merged commit aec1539 into kubernetes-sigs:master Oct 1, 2020
@DirectXMan12 DirectXMan12 deleted the features/actions-verifier branch October 1, 2020 18:18
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
approved Indicates a PR has been approved by an approver from all required OWNERS files. cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. lgtm "Looks good to me", indicates that a PR is ready to be merged. size/XXL Denotes a PR that changes 1000+ lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants