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.

Sign up for GitHub

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

Jump to bottom

Update pull request template user-facing changes instructions #7878

Closed
wants to merge 1 commit into from
Closed

Update pull request template user-facing changes instructions #7878

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 4 additions & 2 deletions .github/PULL_REQUEST_TEMPLATE.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,9 +23,11 @@
<!-- Link any related issues, pull-requests, or commit hashes that are relevant to this pull request. If you are opening a PR without a corresponding issue please consider creating one first, at https://github.com/k3s-io/k3s/issues . A functional example will greatly help QA with verifying/reproducing a bug or testing new features. -->

#### User-Facing Change ####
<!-- If there are User-Facing changes, follow the instructions below, if not, leave the block empty. -->
<!--
Does this PR introduce a user-facing change? If no, just write "NONE" in the release-note block below.
If the PR requires additional action from users switching to the new release, include the string "action required".
Each change should be in a new line;
The first character of each line must be a letter;
If the PR requires additional action from users switching to the new release, include the string "action required";
Comment on lines +28 to +30
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can we keep the note about NONE, assuming that still prevents the PR from showing up in the release notes?

Suggested change
Each change should be in a new line;
The first character of each line must be a letter;
If the PR requires additional action from users switching to the new release, include the string "action required";
Each change note should be on a line by itself.
Each change note should be a complete sentence, starting with a capitalized word and ending with punctuation.
If the change requires additional action from users switching to the new release, include the string "action required" in the note.
If the change has no user impact or should otherwise be hidden from the release notes, use the bare word NONE as the note.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Most PRs don't adhere to this, and some write it outside the block or a different text. The gen_release_notes command will ignore the block if it's empty, so I think it makes sense to remove it, here are some examples:
#7873, #7872, #7858, #7839, #7834, #7833, #7827, #7805, #7777, #7776, #7259, #7153, #6998

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think it's easier for all involved to have a literal nothing than a word to indicate nothing. Less complicated tooling then.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The current behavior is for the tool to use the PR title instead of the note if there is no note, right? This for compatibility with RKE2 where we don't have a note section in the PR template.

If we wanted to change the behavior to omit the PR from the release notes if there is no note (making omission the default, instead of opted into by using the literal string NONE as the note), that'd be fine by me.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The current behavior, is that we include all the PR titles, plus a list of the changes described in the User-Facing release-note block. If the block is missing, empty or just "NONE", we just use the title. https://github.com/rancher/ecm-distro-tools/blob/77c9043241babf6b58f428344125ebdd7ea2f6c8/repository/repository.go#L308-L326

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I believe we need some way to exclude things from the release notes. I don't have strong feelings on whether that is an opt-out, or opt-in, but the special handling for NONE was documented in the PR template and was intended as a way to prevent the release notes from being polluted with meaningless changes, such as pure CI/dev changes that do not have any impact on end users.

-->
```release-note

Expand Down