Skip to content

Render notes with no kind information as normal Changes by Kind #1159

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
Merged
merged 1 commit into from
Mar 7, 2020
Merged

Render notes with no kind information as normal Changes by Kind #1159

merged 1 commit into from
Mar 7, 2020

Conversation

j0n3lson
Copy link
Contributor

@j0n3lson j0n3lson commented Mar 7, 2020 •
edited
Loading

What type of PR is this?

/kind design

What this PR does / why we need it:

There are two main changes here:

  • Bug fix: Template rendering was not rendering notes for PRs with no kinds (e.g uncategorized)
  • Design change: This eliminates the need to have an explicit NotesUncategorized field.

Which issue(s) this PR fixes:
None

Special notes for your reviewer:

This is needed to unblock pr1148 and takes a step toward pr1154. Both those changes and this one enhance encapsulation of the note kinds in support of simplifying template based rendering.

Does this PR introduce a user-facing change?:

Uncategorized notes are now rendered under the "Change By Kind" heading. The Document struct no longer has the NotesUncategorized field (action required).

@k8s-ci-robot k8s-ci-robot added release-note-action-required Denotes a PR that introduces potentially breaking changes that require user action. kind/design Categorizes issue or PR as related to design. cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. needs-priority needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. labels Mar 7, 2020
@k8s-ci-robot
Copy link
Contributor

Hi @j0n3lson. Thanks for your PR.

I'm waiting for a kubernetes member to verify that this patch is reasonable to test. If it is, they should reply with /ok-to-test on its own line. Until that is done, I will not automatically test new commits in this PR, but the usual testing commands by org members will still work. Regular contributors should join the org to skip this step.

Once the patch is verified, the new status will be reflected by the ok-to-test label.

I understand the commands that are listed here.

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository.

@k8s-ci-robot k8s-ci-robot added the size/M Denotes a PR that changes 30-99 lines, ignoring generated files. label Mar 7, 2020
@j0n3lson j0n3lson changed the title Render notes with no kind information as Other. Render notes with no kind information as normal Changes by Kind Mar 7, 2020
@k8s-ci-robot k8s-ci-robot added area/release-eng Issues or PRs related to the Release Engineering subproject sig/release Categorizes an issue or PR as relevant to SIG Release. labels Mar 7, 2020
@j0n3lson j0n3lson mentioned this pull request Mar 7, 2020
Closed
@j0n3lson
Render notes with no kind information as normal Changes by Kind
bb29081 
There are two main changes here:

* Bug fix: Template rendering was not rendering notes for PRs with no kinds (e.g
uncategorized)

* Design change: This eliminates the need to have an explicit NotesUncategorized
field.
@saschagrunert
Copy link
Member

/ok-to-test

@k8s-ci-robot k8s-ci-robot added ok-to-test Indicates a non-member PR verified by an org member that is safe to test. and removed needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. labels Mar 7, 2020
saschagrunert
saschagrunert approved these changes Mar 7, 2020
View reviewed changes
Copy link
Member

@saschagrunert saschagrunert left a comment

Choose a reason for hiding this comment

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

That’s cool, something I had on my todo list as well 👍 thank you!

/lgtm

@k8s-ci-robot k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Mar 7, 2020
@k8s-ci-robot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: j0n3lson, saschagrunert

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 the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Mar 7, 2020
@k8s-ci-robot k8s-ci-robot merged commit 0eb2e92 into kubernetes:master Mar 7, 2020
@k8s-ci-robot k8s-ci-robot added this to the v1.18 milestone Mar 7, 2020
@j0n3lson j0n3lson deleted the pr1008-render-uncategorized branch March 7, 2020 10:36
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@saschagrunert saschagrunert saschagrunert approved these changes

@marpaia marpaia Awaiting requested review from marpaia

Assignees

@saschagrunert saschagrunert

Labels
approved Indicates a PR has been approved by an approver from all required OWNERS files. area/release-eng Issues or PRs related to the Release Engineering subproject cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. kind/design Categorizes issue or PR as related to design. lgtm "Looks good to me", indicates that a PR is ready to be merged. needs-priority ok-to-test Indicates a non-member PR verified by an org member that is safe to test. release-note-action-required Denotes a PR that introduces potentially breaking changes that require user action. sig/release Categorizes an issue or PR as relevant to SIG Release. size/M Denotes a PR that changes 30-99 lines, ignoring generated files.
Projects
None yet
Milestone
v1.18
Development

Successfully merging this pull request may close these issues.
3 participants
@j0n3lson @k8s-ci-robot @saschagrunert