From c5bfbec448added37bc2bb861b93ce03bf431063 Mon Sep 17 00:00:00 2001 From: Vince Prignano Date: Tue, 20 Jul 2021 08:22:05 -0700 Subject: [PATCH] :book: Update how we generate release notes Signed-off-by: Vince Prignano --- Makefile | 9 --------- docs/developer/releasing.md | 2 +- 2 files changed, 1 insertion(+), 10 deletions(-) diff --git a/Makefile b/Makefile index 54d32e3352aa..8747427ed900 100644 --- a/Makefile +++ b/Makefile @@ -58,8 +58,6 @@ TOOLS_DIR := hack/tools TOOLS_BIN_DIR := $(TOOLS_DIR)/$(BIN_DIR) E2E_FRAMEWORK_DIR := $(TEST_DIR)/framework CAPD_DIR := $(TEST_DIR)/infrastructure/docker -RELEASE_NOTES_BIN := $(BIN_DIR)/release-notes -RELEASE_NOTES := $(TOOLS_DIR)/$(RELEASE_NOTES_BIN) GO_APIDIFF_BIN := $(BIN_DIR)/go-apidiff GO_APIDIFF := $(TOOLS_DIR)/$(GO_APIDIFF_BIN) ENVSUBST_BIN := $(BIN_DIR)/envsubst @@ -206,9 +204,6 @@ $(GOTESTSUM): $(TOOLS_DIR)/go.mod # Build gotestsum from tools folder. $(CONVERSION_GEN): $(TOOLS_DIR)/go.mod cd $(TOOLS_DIR); go build -tags=tools -o $(BIN_DIR)/conversion-gen k8s.io/code-generator/cmd/conversion-gen -$(RELEASE_NOTES): $(TOOLS_DIR)/go.mod - cd $(TOOLS_DIR) && go build -tags=tools -o $(RELEASE_NOTES_BIN) ./release - $(GO_APIDIFF): $(TOOLS_DIR)/go.mod cd $(TOOLS_DIR) && go build -tags=tools -o $(GO_APIDIFF_BIN) github.com/joelanford/go-apidiff @@ -592,10 +587,6 @@ release-alias-tag: ## Adds the tag to the last build tag. gcloud container images add-tag $(KUBEADM_BOOTSTRAP_CONTROLLER_IMG):$(TAG) $(KUBEADM_BOOTSTRAP_CONTROLLER_IMG):$(RELEASE_ALIAS_TAG) gcloud container images add-tag $(KUBEADM_CONTROL_PLANE_CONTROLLER_IMG):$(TAG) $(KUBEADM_CONTROL_PLANE_CONTROLLER_IMG):$(RELEASE_ALIAS_TAG) -.PHONY: release-notes -release-notes: $(RELEASE_NOTES) ## Generates a release notes template to be used with a release. - $(RELEASE_NOTES) - ## -------------------------------------- ## Cleanup / Verification ## -------------------------------------- diff --git a/docs/developer/releasing.md b/docs/developer/releasing.md index 71cb474b0e45..961efeeb86ab 100644 --- a/docs/developer/releasing.md +++ b/docs/developer/releasing.md @@ -67,7 +67,7 @@ For version v0.x.y: 1. Run `make release` to build artifacts (the image is automatically built by CI) 1. Follow the [Image Promotion process](https://git.k8s.io/k8s.io/k8s.gcr.io#image-promoter) to promote the image from the staging repo to `k8s.gcr.io/cluster-api` 1. Create a release in GitHub based on the tag created above -1. Release notes can be created by running `make release-notes`, which will generate an output that can be copied to the drafted release in GitHub. +1. Release notes can be created by running `go run ./hack/tools/release/notes.go --from=`, which will generate an output that can be copied to the drafted release in GitHub. Pay close attention to the `## :question: Sort these by hand` section, as it contains items that need to be manually sorted. ### Permissions