Simplify Release Notes section of the PR checklist #5094
Conversation
This commit simplifies the release notes section by replacing the existing comment with a default `NONE` release note. In addition it updates the submitter checklist instruction to expect the submitter to update the release note if needed. In addition, it adds two new items to the checklist - 1. to add a kind label using the /kind command and 2. add an `action required:` to the release note if needed. Fixes tektoncd#5093 Signed-off-by: Dibyo Mukherjee <[email protected]>
tekton-robot
added
do-not-merge/release-note-label-needed
tekton-robot
added
release-note-none
|
As a case in point, I copy pasted the example release note from the instructions but because I forgot to remove the extra space between the backticks and release-note, I got the do-not-merge/release-note-label-neeeded label 😒 |
|
[APPROVALNOTIFIER] This PR is APPROVED This pull-request has been approved by: vdemeester 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 |
tekton-robot
added
the
approved
|
/kind misc |
|
/retest |
| ``` | ||
|
|
||
| For pull requests that don't need to be mentioned at release time, use the `/release-note-none` Prow command to add the `release-note-none` label to the PR. You can also write the string "NONE" as a release note in your PR description: | ||
|
|
||
| ``` release-note |
There was a problem hiding this comment.
I would remove the space between the ticks and release-note - it's very hard to spot so many PRs fail the release notes check because of that
There was a problem hiding this comment.
So we added it to make sure it would "fail" the check and make contributors look at it (described in the comment).
If we don't, by default all pr will have release-note-none and no message telling the user about release-note 🙃
There was a problem hiding this comment.
I know, but TBH I find it a bit confusing... we have the checkbox about setting the release notes now, hopefully that's enough?
Changes
This commit simplifies the release notes section by replacing the existing
comment with a default
NONErelease note. In addition it updates thesubmitter checklist instruction to expect the submitter to update the release
note if needed. In addition, it adds two new items to the checklist - 1. to add
a kind label using the /kind command and 2. add an
action required:to therelease note if needed.
Fixes #5093
Signed-off-by: Dibyo Mukherjee [email protected]
Submitter Checklist
As the author of this PR, please check off the items in this checklist:
functionality, content, code)
(if there are no user facing changes, use release note "NONE")
Release Notes