Skip to content

Skip mapped release-note-none notes - #4474

Open
SaaiAravindhRaja wants to merge 1 commit into
kubernetes:masterfrom
SaaiAravindhRaja:docs/release-note-map-precedence
Open

Skip mapped release-note-none notes#4474
SaaiAravindhRaja wants to merge 1 commit into
kubernetes:masterfrom
SaaiAravindhRaja:docs/release-note-map-precedence

Conversation

@SaaiAravindhRaja

Copy link
Copy Markdown

What type of PR is this?

/kind bug
/kind documentation

What this PR does / why we need it:

Fixes release note rendering so PRs marked release-note-none stay out of the generated document even when a release notes map exists for the PR. The document builder now skips any note marked DoNotPublish, regardless of whether it was mapped.

The tests cover unmapped release-note-none notes, mapped release-note-none notes, and mapped notes explicitly suppressed with releasenote.do_not_publish: true. The map documentation also clarifies that merely adding a map does not clear a PR-level release-note-none exclusion.

Which issue(s) this PR fixes:

Fixes #4456

Special notes for your reviewer:

None

Does this PR introduce a user-facing change?

NONE

Testing

  • go test ./pkg/notes ./pkg/notes/document -run 'TestApplyMap|TestApplyMapPreservesDoNotPublish|TestNew' -count=1
  • go test ./pkg/notes -count=1
  • git diff --name-only origin/master...HEAD -- '*.go' | xargs gofmt -l
  • git diff --check origin/master...HEAD
  • gitleaks detect --no-banner --redact --source . --log-opts origin/master..HEAD

@kubernetes-prow kubernetes-prow Bot added release-note-none Denotes a PR that doesn't merit a release note. kind/bug Categorizes issue or PR as related to a bug. kind/documentation Categorizes issue or PR as related to documentation. area/release-eng Issues or PRs related to the Release Engineering subproject labels Jul 21, 2026
@kubernetes-prow
kubernetes-prow Bot requested a review from jimangel July 21, 2026 11:15
@kubernetes-prow kubernetes-prow Bot added sig/release Categorizes an issue or PR as relevant to SIG Release. needs-priority cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. labels Jul 21, 2026
@kubernetes-prow
kubernetes-prow Bot requested a review from jrsapi July 21, 2026 11:15
@kubernetes-prow

Copy link
Copy Markdown
Contributor

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by: SaaiAravindhRaja
Once this PR has been reviewed and has the lgtm label, please assign palnabarun for approval. For more information see the Code Review Process.

The full list of commands accepted by this bot can be found here.

Details 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

@kubernetes-prow

Copy link
Copy Markdown
Contributor

Welcome @SaaiAravindhRaja!

It looks like this is your first PR to kubernetes/release 🎉. Please refer to our pull request process documentation to help your PR have a smooth ride to approval.

You will be prompted by a bot to use commands during the review process. Do not be afraid to follow the prompts! It is okay to experiment. Here is the bot commands documentation.

You can also check if kubernetes/release has its own contribution guidelines.

You may want to refer to our testing guide if you run into trouble with your tests not passing.

If you are having difficulty getting your pull request seen, please follow the recommended escalation practices. Also, for tips and tricks in the contribution process you may want to read the Kubernetes contributor cheat sheet. We want to make sure your contribution gets all the attention it needs!

Thank you, and welcome to Kubernetes. 😃

@kubernetes-prow

Copy link
Copy Markdown
Contributor

Hi @SaaiAravindhRaja. 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.

Details

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-sigs/prow repository.

@kubernetes-prow kubernetes-prow Bot added needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. size/L Denotes a PR that changes 100-499 lines, ignoring generated files. labels Jul 21, 2026
@SaaiAravindhRaja

Copy link
Copy Markdown
Author

hi is there anything i can improve on?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

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/bug Categorizes issue or PR as related to a bug. kind/documentation Categorizes issue or PR as related to documentation. needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. needs-priority release-note-none Denotes a PR that doesn't merit a release note. sig/release Categorizes an issue or PR as relevant to SIG Release. size/L Denotes a PR that changes 100-499 lines, ignoring generated files.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

krel includes PR with release-note-none when a release notes map file exists

1 participant