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 tests (💚) and chores (🔨) categories to release notes #4853

Conversation

CecileRobertMichon
Copy link
Contributor

What this PR does / why we need it: Improvements following the v0.4.0 release process, there were too many PRs categorized "others", a lot of them not user-facing and irrelevant for release notes. This adds two new categories:

  • 💚 (:green_heart:, tests)
  • 🔨 (:hammer: chores, infra, maintenance - these will not appear in release notes)

Which issue(s) this PR fixes (optional, in fixes #<issue number>(, fixes #<issue_number>, ...) format, will close the issue(s) when PR gets merged):
Fixes #

@k8s-ci-robot k8s-ci-robot added the cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. label Jun 24, 2021
@k8s-ci-robot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by:
To complete the pull request process, please ask for approval from cecilerobertmichon after the PR has been reviewed.

The full list of commands accepted by this bot can be found 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 size/S Denotes a PR that changes 10-29 lines, ignoring generated files. label Jun 24, 2021
@CecileRobertMichon
Copy link
Contributor Author

So the PR verify test is failing because it is using a github action from kubebuilder-release-tools which doesn't recognize the new emojis https://github.com/kubernetes-sigs/kubebuilder-release-tools/blob/master/verify/type.go#L44

The options going forward I see are:

  1. not add the new emojis, close this PR - not great, we're stuck having a bunch of irrelevant commits in "others"
  2. fork the github action and modify it to have it be specific to CAPI and our own VERSIONING.md - duplication of code/effort but at least we wouldn't be broken by any unexpected changes to the action later on
  3. open a PR in kubebuilder-release-tools to add the new emojis in the action - problem there is that change would affect all projects using it, including KubeBuilder, controller-runtime, and controller-tools which might not be good if those projects don't want to adopt our proposed emojis. They would have to modify their release notes scripts to handle these emojis or risk PRs coming in being classified as "unknown".

@enxebre
Copy link
Member

enxebre commented Jun 29, 2021

Alternatively how about we drop seedling from the release notes? and consider anything that deserves a release note either a feature addition or a bug fix?

@CecileRobertMichon
Copy link
Contributor Author

Alternatively how about we drop seedling from the release notes? and consider anything that deserves a release note either a feature addition or a bug fix?

@vincepri thoughts on ^ ?

@vincepri
Copy link
Member

vincepri commented Jul 6, 2021

I'd rather not fully drop it, because sometimes it's useful to see what has changed, it's the really minor ones that are usually removed.

Let's PR the tools, I think we can release a new version of the github action so folks can move to the new system over time

@vincepri
Copy link
Member

@CecileRobertMichon How do you want to proceed here?

@CecileRobertMichon
Copy link
Contributor Author

This slipped my mind. I'll open PRs for release-tools when I get a chance

@k8s-ci-robot
Copy link
Contributor

k8s-ci-robot commented Aug 11, 2021

@CecileRobertMichon: The following test failed, say /retest to rerun all failed tests or /retest-required to rerun all mandatory failed tests:

Test name Commit Details Required Rerun command
pull-cluster-api-test-main-mink8s 3843a24 link /test pull-cluster-api-test-main-mink8s

Full PR test history. Your PR dashboard. Please help us cut down on flakes by linking to an open issue when you hit one in your PR.

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. I understand the commands that are listed here.

@CecileRobertMichon
Copy link
Contributor Author

Going to revisit this to see how we can use https://github.blog/2021-10-04-beta-github-releases-improving-release-experience/ instead of maintaining our own tooling.

/close

@k8s-ci-robot
Copy link
Contributor

@CecileRobertMichon: Closed this PR.

In response to this:

Going to revisit this to see how we can use https://github.blog/2021-10-04-beta-github-releases-improving-release-experience/ instead of maintaining our own tooling.

/close

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.

@sbueringer
Copy link
Member

sbueringer commented Oct 5, 2021

Going to revisit this to see how we can use https://github.blog/2021-10-04-beta-github-releases-improving-release-experience/ instead of maintaining our own tooling.

/close

Maybe this also allows us to switch to merge_method squash (afaik we only need "merge" for the release notes generation)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. 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.

5 participants