Merge pull request #4472 from richardcase/release_notes_gen

feat: use k/k tooling for release notes

Author: k8s-ci-robot

Makefile

@@ -65,6 +65,8 @@ MOCKGEN := $(TOOLS_BIN_DIR)/mockgen
 SSM_PLUGIN := $(TOOLS_BIN_DIR)/session-manager-plugin
 YQ := $(TOOLS_BIN_DIR)/yq
 KPROMO := $(TOOLS_BIN_DIR)/kpromo
+RELEASE_NOTES := $(TOOLS_BIN_DIR)/release-notes
+
 CLUSTERAWSADM_SRCS := $(call rwildcard,.,cmd/clusterawsadm/*.*)
 
 PATH := $(abspath $(TOOLS_BIN_DIR)):$(PATH)
@@ -577,8 +579,8 @@ release-manifests: ## Release manifest files
 	cp metadata.yaml $(RELEASE_DIR)/metadata.yaml
 
 .PHONY: release-changelog
-release-changelog: $(GH) ## Generates release notes using Github release notes.
-	./hack/releasechangelog.sh -v $(VERSION) -p $(PREVIOUS_VERSION) -o $(GH_ORG_NAME) -r $(GH_REPO_NAME) -c $(CORE_CONTROLLER_PROMOTED_IMG) > $(RELEASE_DIR)/CHANGELOG.md
+release-changelog: $(RELEASE_NOTES) check-release-tag check-previous-release-tag check-github-token $(RELEASE_DIR)
+	$(RELEASE_NOTES) --debug --org $(GH_ORG_NAME) --repo $(GH_REPO_NAME) --start-sha $(shell git rev-list -n 1 ${PREVIOUS_VERSION}) --end-sha $(shell git rev-list -n 1 ${RELEASE_TAG}) --output $(RELEASE_DIR)/CHANGELOG.md --go-template go-template:$(REPO_ROOT)/hack/changelog.tpl --dependencies=true
 
 .PHONY: promote-images
 promote-images: $(KPROMO) $(YQ)

hack/changelog.tpl

@@ -0,0 +1,27 @@
+# Release notes for Cluster API Provider AWS (CAPA) <RELEASE_VERSION>
+
+[Documentation](https://cluster-api-aws.sigs.k8s.io/)
+
+# Changelog since <PREVIOUS_VERSION>
+
+{{with .NotesWithActionRequired -}}
+## Urgent Upgrade Notes 
+
+### (No, really, you MUST read this before you upgrade)
+
+{{range .}}{{println "-" .}} {{end}}
+{{end}}
+
+{{- if .Notes -}}
+## Changes by Kind
+{{ range .Notes}}
+### {{.Kind | prettyKind}}
+
+{{range $note := .NoteEntries }}{{println "-" $note}}{{end}}
+{{- end -}}
+{{- end }}
+
+The images for this release are:
+<ADD_IMAGE_HERE>
+
+Thanks to all our contributors.

hack/releasechangelog.sh

@@ -174,6 +174,15 @@ $(GOLANGCI_LINT_BIN): $(GOLANGCI_LINT) ## Build a local copy of golangci-lint.
 $(GOLANGCI_LINT): # Build golangci-lint from tools folder.
 	GOBIN=$(abspath $(BIN_DIR)) go install $(GOLANGCI_LINT_PKG)@$(GOLANGCI_LINT_VERSION)
 
+RELEASE_NOTES_BIN := release-notes
+RELEASE_NOTES := $(BIN_DIR)/$(RELEASE_NOTES_BIN)
+RELEASE_NOTES_PKG := k8s.io/release/cmd/release-notes
+.PHONY: $(RELEASE_NOTES_BIN)
+$(RELEASE_NOTES_BIN): $(RELEASE_NOTES)
+
+$(RELEASE_NOTES): ## Build release notes from tools folders.
+	GOBIN=$(abspath $(BIN_DIR)) go install $(RELEASE_NOTES_PKG)@$(RELEASE_NOTES_VERSION)
+
 
 ## ------------------------------------------------------------------------------------------------
 ## AWS Session Manager Plugin Installation. Currently support Linux and MacOS AMD64 architectures.

hack/tools/Makefile

@@ -20,3 +20,4 @@ CAPI_VERSION := v1.4.4
 KPROMO_VERSION := v4.0.4
 YQ_VERSION := v4.25.2
 GOLANGCI_LINT_VERSION := v1.52.2
+RELEASE_NOTES_VERSION := v0.11.0