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鈥檒l occasionally send you account related emails.
Already on GitHub? Sign in to your account
release-notes check subcommand #3406
Conversation
Signed-off-by: Adolfo Garc铆a Veytia (Puerco) <adolfo.garcia@uservers.net>
This commit adds a new subcommand to make the `generate` subcommand the default when running the binary without a subcommand. This avoids breaking compatibility with previous versions. Signed-off-by: Adolfo Garc铆a Veytia (Puerco) <adolfo.garcia@uservers.net>
This commit adds a function that returns the release note of a pull request. Signed-off-by: Adolfo Garc铆a Veytia (Puerco) <adolfo.garcia@uservers.net>
Signed-off-by: Adolfo Garc铆a Veytia (Puerco) <adolfo.garcia@uservers.net>
This commit adds a new "check" subcommand to the release-notes utility. This subcommand reads a PR from the github API and check if it has a valid release note. If not it exits non-zero. It is designed to easily add a PR check in CI to enforce authors to add release notes. Signed-off-by: Adolfo Garc铆a Veytia (Puerco) <adolfo.garcia@uservers.net>
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.
Cool nice one
/approve
/lgtm
[APPROVALNOTIFIER] This PR is APPROVED This pull-request has been approved by: cpanato, puerco 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 |
What type of PR is this?
/kind feature
What this PR does / why we need it:
This PR adds a new
check
subcommand torelease-notes
. This command is designed tu run in CI to make it easy to enforce kubernetes-style release notes in PRs. The subcommand takes one or more PR numbers and will exit non-zero if the PRs are missing the release-notes block or a valid release note. It supportsNONE
or adding therelease-note-none
label to skip the note enforcement.Here's the output from the subcommand help:
When failing the subcommand will print a short help text to guide contributors looking at the logs:
Which issue(s) this PR fixes:
None
Special notes for your reviewer:
This subcommand will be part of a new release-notes action in k-sigs/release-actions 馃殌
(first part is here)
/assign @cpanato
Does this PR introduce a user-facing change?
Signed-off-by: Adolfo Garc铆a Veytia (Puerco) adolfo.garcia@uservers.net