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

🌱 update release-notes make target + corresponding doc #9573

Conversation

cahillsf
Copy link
Member

@cahillsf cahillsf commented Oct 18, 2023

What this PR does / why we need it:
Updates the make target (which is not in use anymore) and the corresponding documentation for generating the release PR. The notes tool is frequently iterated on and to avoid excess overhead of backporting all the changes to release-* branches the updated process is to always build the binary from main, then checkout the relevant branches.

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 #9556

/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. size/S Denotes a PR that changes 10-29 lines, ignoring generated files. labels Oct 18, 2023
@cahillsf cahillsf changed the title update make target + corresponding doc 🌱 update make target + corresponding doc Oct 18, 2023
@cahillsf
Copy link
Member Author

cc @furkatgofurov7

Makefile Outdated
else \
go run ./hack/tools/release/notes.go --from=$(PREVIOUS_TAG) > $(RELEASE_NOTES_DIR)/$(RELEASE_TAG).md; \
fi
release-notes:
Copy link
Contributor

Choose a reason for hiding this comment

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

We should probably update this target to be release-notes tool, as it's confusing to have this target just build the tool rather than producing the notes themselves.

Copy link
Member

Choose a reason for hiding this comment

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

@killianmuldoon the target is already named as you are suggesting, perhaps you meant something else?

Copy link
Member

Choose a reason for hiding this comment

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

I think he meant something like

build-release-notes-tool or release-notes-tool.

Copy link
Member Author

Choose a reason for hiding this comment

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

pushed up some changes that i think resolve this -- lmk if i misunderstood the recommendation

@chrischdi
Copy link
Member

/retitle 🌱 update release-notes make target + corresponding doc

@k8s-ci-robot k8s-ci-robot changed the title 🌱 update make target + corresponding doc 🌱 update release-notes make target + corresponding doc Oct 19, 2023
@cahillsf cahillsf force-pushed the cahillsf/update-release-notes-gen-process branch from 01c06cd to 309c7a7 Compare October 19, 2023 21:44
@cahillsf cahillsf force-pushed the cahillsf/update-release-notes-gen-process branch from 2bb50f1 to de1b74c Compare October 19, 2023 21:45
Copy link
Member

@furkatgofurov7 furkatgofurov7 left a comment

Choose a reason for hiding this comment

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

Looks good to me, thanks @cahillsf!

/lgtm

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

LGTM label has been added.

Git tree hash: 44c8e3ef27c9e7998cc2c043ccfa7305343f1e2a

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.

Thanks!

/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 Oct 20, 2023
@k8s-ci-robot k8s-ci-robot merged commit dc64556 into kubernetes-sigs:main Oct 20, 2023
13 checks passed
@k8s-ci-robot k8s-ci-robot added this to the v1.6 milestone Oct 20, 2023
@cahillsf cahillsf deleted the cahillsf/update-release-notes-gen-process branch October 20, 2023 13:02
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/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.

Improve and clarify release-notes tool usage
5 participants