From 2605d59bdd3c39fc12f0258d4fc4be2b749a9459 Mon Sep 17 00:00:00 2001 From: Pavel Boldyrev <627562+bpg@users.noreply.github.com> Date: Wed, 8 Sep 2021 22:17:05 -0400 Subject: [PATCH] add `scripts` folder --- scripts/changelog-links.sh | 31 ++++++++++++++++++++ scripts/changelog.tmpl | 41 ++++++++++++++++++++++++++ scripts/generate-changelog.sh | 54 +++++++++++++++++++++++++++++++++++ 3 files changed, 126 insertions(+) create mode 100755 scripts/changelog-links.sh create mode 100644 scripts/changelog.tmpl create mode 100755 scripts/generate-changelog.sh diff --git a/scripts/changelog-links.sh b/scripts/changelog-links.sh new file mode 100755 index 00000000..f7e2e692 --- /dev/null +++ b/scripts/changelog-links.sh @@ -0,0 +1,31 @@ +#!/bin/bash + +# This script rewrites [GH-nnnn]-style references in the CHANGELOG.md file to +# be Markdown links to the given github issues. +# +# This is run during releases so that the issue references in all of the +# released items are presented as clickable links, but we can just use the +# easy [GH-nnnn] shorthand for quickly adding items to the "Unrelease" section +# while merging things between releases. + +set -e + +if [[ ! -f CHANGELOG.md ]]; then + echo "ERROR: CHANGELOG.md not found in pwd." + echo "Please run this from the root of the terraform provider repository" + exit 1 +fi + +if [[ `uname` == "Darwin" ]]; then + echo "Using BSD sed" + SED="sed -i.bak -E -e" +else + echo "Using GNU sed" + SED="sed -i.bak -r -e" +fi + +PROVIDER_URL="https:\/\/github.com\/hashicorp\/terraform-provider-aws\/issues" + +$SED "s/GH-([0-9]+)/\[#\1\]\($PROVIDER_URL\/\1\)/g" -e 's/\[\[#(.+)([0-9])\)]$/(\[#\1\2))/g' CHANGELOG.md + +rm CHANGELOG.md.bak diff --git a/scripts/changelog.tmpl b/scripts/changelog.tmpl new file mode 100644 index 00000000..46b67141 --- /dev/null +++ b/scripts/changelog.tmpl @@ -0,0 +1,41 @@ + +{{- if index .NotesByType "breaking-change" }} +BREAKING CHANGES: + +{{range index .NotesByType "breaking-change" -}} +{{ template "note" .}} +{{ end -}} +{{- end -}} + +{{- if .NotesByType.note }} +NOTES: + +{{range .NotesByType.note -}} +{{ template "note" .}} +{{ end -}} +{{- end -}} + +{{- $features := combineTypes .NotesByType.feature (index .NotesByType "new-resource" ) (index .NotesByType "new-data-source") (index .NotesByType "new-guide") }} +{{- if $features }} +FEATURES: + +{{range $features | sort -}} +{{ template "note" . }} +{{ end -}} +{{- end -}} + +{{- if .NotesByType.enhancement }} +ENHANCEMENTS: + +{{range .NotesByType.enhancement | sort -}} +{{ template "note" .}} +{{ end -}} +{{- end -}} + +{{- if .NotesByType.bug }} +BUG FIXES: + +{{range .NotesByType.bug | sort -}} +{{ template "note" . }} +{{ end -}} +{{- end -}} diff --git a/scripts/generate-changelog.sh b/scripts/generate-changelog.sh new file mode 100755 index 00000000..a5a09b9a --- /dev/null +++ b/scripts/generate-changelog.sh @@ -0,0 +1,54 @@ +#!/bin/bash + +set -o errexit +set -o nounset + +__dir="$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)" +__parent="$(dirname "$__dir")" + +CHANGELOG_FILE_NAME="CHANGELOG.md" +CHANGELOG_TMP_FILE_NAME="CHANGELOG.tmp" +TARGET_SHA=$(git rev-parse HEAD) +PREVIOUS_RELEASE_TAG=$(git describe --abbrev=0 --match='v*.*.*' --tags) +PREVIOUS_RELEASE_SHA=$(git rev-list -n 1 $PREVIOUS_RELEASE_TAG) + +if [ $TARGET_SHA == $PREVIOUS_RELEASE_SHA ]; then + echo "Nothing to do" + exit 0 +fi + +PREVIOUS_CHANGELOG=$(sed -n -e "/# ${PREVIOUS_RELEASE_TAG#v}/,\$p" $__parent/$CHANGELOG_FILE_NAME) + +if [ -z "$PREVIOUS_CHANGELOG" ] +then + echo "Unable to locate previous changelog contents." + exit 1 +fi + +CHANGELOG=$($(go env GOPATH)/bin/changelog-build -this-release $TARGET_SHA \ + -last-release $PREVIOUS_RELEASE_SHA \ + -git-dir $__parent \ + -entries-dir .changelog \ + -changelog-template $__dir/changelog.tmpl \ + -note-template $__dir/release-note.tmpl \ + -storage-mode filesystem) +if [ -z "$CHANGELOG" ] +then + echo "No changelog generated." + exit 0 +fi + +rm -f $CHANGELOG_TMP_FILE_NAME + +sed -n -e "1{/# /p;}" $__parent/$CHANGELOG_FILE_NAME > $CHANGELOG_TMP_FILE_NAME +echo "$CHANGELOG" >> $CHANGELOG_TMP_FILE_NAME +echo >> $CHANGELOG_TMP_FILE_NAME +echo "$PREVIOUS_CHANGELOG" >> $CHANGELOG_TMP_FILE_NAME + +cp $CHANGELOG_TMP_FILE_NAME $CHANGELOG_FILE_NAME + +rm $CHANGELOG_TMP_FILE_NAME + +echo "Successfully generated changelog." + +exit 0 \ No newline at end of file