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.

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

Add sig labels to markdown #3684

Merged

Conversation

npolshakova
Copy link
Contributor

@npolshakova npolshakova commented Jul 18, 2024

What type of PR is this?

/kind bug

What this PR does / why we need it:

Slack discussion: https://kubernetes.slack.com/archives/CN1KH4K9A/p1721224163843589

Which issue(s) this PR fixes:

When the map file text is replaced, the resulting markdown does not include the SIG labels. See an example of this where the old release notes have the sig labels removed.

You can reproduce this by running with the latest krel:

go run ./cmd/krel release-notes --create-draft-pr --fork=npolshakova --fix --tag  v1.31.0-alpha.3 --list-v2 --log-level trace --repo=/Users/ninapolshakova/kubernetes/kubernetes

Special notes for your reviewer:

None

Does this PR introduce a user-facing change?

Edited release notes by the release notes team will now have the sig labels included at the end of the markdown.

@k8s-ci-robot k8s-ci-robot added kind/bug Categorizes issue or PR as related to a bug. release-note-none Denotes a PR that doesn't merit a release note. cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. needs-priority 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 Jul 18, 2024
@k8s-ci-robot k8s-ci-robot added the size/S Denotes a PR that changes 10-29 lines, ignoring generated files. label Jul 18, 2024
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.

Just a nit. @npolshakova thank you for approaching a fix! Can you verify if that works for you?

pkg/notes/notes.go Outdated Show resolved Hide resolved
@k8s-ci-robot k8s-ci-robot added release-note Denotes a PR that will be considered when it comes time to generate release notes. and removed release-note-none Denotes a PR that doesn't merit a release note. labels Jul 18, 2024
Co-authored-by: Sascha Grunert <sgrunert@redhat.com>
@npolshakova
Copy link
Contributor Author

Just a nit. @npolshakova thank you for approaching a fix! Can you verify if that works for you?

Yep, the unit test confirmed it but I also re-ran krel to sanity check the sig labels are now being added and none of the sig labels are removed: https://github.com/kubernetes/sig-release/pull/2570/files#r1683006327

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

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: npolshakova, 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 Jul 18, 2024
@k8s-ci-robot k8s-ci-robot merged commit dbda6e5 into kubernetes:master Jul 18, 2024
11 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
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/bug Categorizes issue or PR as related to a bug. lgtm "Looks good to me", indicates that a PR is ready to be merged. needs-priority release-note Denotes a PR that will be considered when it comes time to generate release notes. sig/release Categorizes an issue or PR as relevant to SIG Release. size/S Denotes a PR that changes 10-29 lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants