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

🌱 Improve release notes formatting #8826

Merged

Conversation

g-gaston
Copy link
Contributor

@g-gaston g-gaston commented Jun 8, 2023

What this PR does / why we need it:
A few life of quality improvements that automate manual steps performed to cleanup the release notes:

  • Capitalize/shorten some area labels into more legible prefixes (API vs api, KCP vs provider/kubeadm-control-plane...)
  • Remove backport PR prefixes "[release-x.x]"
  • Omit "num of change of type x" lines when there are no changes of
    that kind (eg. no breaking changes)
  • Use the area label for documentation to classify PRs that have the wrong emoji prefix in the title. We have seen in the past PR that use the 🐛 or 🌱 instead of 📖 , but they have the area/documentation label. In these cases, the label tends to be more reliable than the PR title, so this PR makes the label take precedence.

I put the last item in a separate commit, since we weren't completely sure if we wanted to automate this yet and if so, what should be the logic. Opening the conversation here.

Builds on top of #8817, so this needs to wait until that's merged. Review only the last two commits pls.

/area release

@k8s-ci-robot k8s-ci-robot added area/release Issues or PRs related to releasing cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. labels Jun 8, 2023
@k8s-ci-robot k8s-ci-robot added the size/L Denotes a PR that changes 100-499 lines, ignoring generated files. label Jun 8, 2023
@g-gaston
Copy link
Contributor Author

g-gaston commented Jun 8, 2023

/hold
until #8817 merges

@k8s-ci-robot k8s-ci-robot added the do-not-merge/hold Indicates that a PR should not merge because someone has issued a /hold command. label Jun 8, 2023
@johannesfrey
Copy link
Contributor

/lgtm

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

LGTM label has been added.

Git tree hash: 948bbe3698155702867a9afc681fb2a12e1dab58

Copy link
Member

@nawazkh nawazkh left a comment

Choose a reason for hiding this comment

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

/lgtm
🚀

Copy link
Member

@fabriziopandini fabriziopandini left a comment

Choose a reason for hiding this comment

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

few nits, otherwise lgtm for me

hack/tools/release/notes.go Outdated Show resolved Hide resolved
hack/tools/release/notes.go Outdated Show resolved Hide resolved
hack/tools/release/notes.go Outdated Show resolved Hide resolved
@k8s-ci-robot k8s-ci-robot removed the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Jun 13, 2023
@g-gaston g-gaston force-pushed the release-notes-formatting-tweaks branch from 513526a to eae3326 Compare June 13, 2023 19:24
@g-gaston g-gaston force-pushed the release-notes-formatting-tweaks branch from 55a1057 to 01aabab Compare June 13, 2023 19:31
@fabriziopandini
Copy link
Member

lgtm pending rebase on top of #8817

* Capitalize/shorten some area labels into more legible prefixes
* Remove backport PR prefixes "[release-x.x]"
* Omit "num of change of type x" lines when there are no changes of
  that kind (eg. no breaking changes)
* Handle unsync emoji and documentation area
@g-gaston g-gaston force-pushed the release-notes-formatting-tweaks branch from 01aabab to 410cf44 Compare June 14, 2023 14:26
@k8s-ci-robot k8s-ci-robot added size/M Denotes a PR that changes 30-99 lines, ignoring generated files. and removed size/L Denotes a PR that changes 100-499 lines, ignoring generated files. labels Jun 14, 2023
@g-gaston
Copy link
Contributor Author

@fabriziopandini rebased 🙌🏻

@fabriziopandini
Copy link
Member

/lgtm
@killianmuldoon @sbueringer PTAL when you have some time

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

LGTM label has been added.

Git tree hash: 02dfafb5881b193171f5661642df960f572ef002

Copy link
Contributor

@killianmuldoon killianmuldoon left a comment

Choose a reason for hiding this comment

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

/lgtm
/approve

@k8s-ci-robot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: killianmuldoon

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 Jun 14, 2023
@g-gaston
Copy link
Contributor Author

/unhold

@k8s-ci-robot k8s-ci-robot removed the do-not-merge/hold Indicates that a PR should not merge because someone has issued a /hold command. label Jun 14, 2023
@k8s-ci-robot k8s-ci-robot merged commit 52fd7eb into kubernetes-sigs:main Jun 14, 2023
@k8s-ci-robot k8s-ci-robot added this to the v1.5 milestone Jun 14, 2023
killianmuldoon pushed a commit to killianmuldoon/cluster-api that referenced this pull request Jun 15, 2023
…ormatting-tweaks

🌱 Improve release notes formatting
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 Issues or PRs related to releasing cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. lgtm "Looks good to me", indicates that a PR is ready to be merged. size/M Denotes a PR that changes 30-99 lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants