changelog: add go-changelog templates and tooling

.changelog/101.txt

@@ -0,0 +1,3 @@
+```release-note:enhancement
+changelog: add go-changelog templates and tooling
+```

.changelog/changelog.tmpl

@@ -0,0 +1,56 @@
+{{- if index .NotesByType "breaking-change" -}}
+BREAKING CHANGES:
+
+{{range index .NotesByType "breaking-change" -}}
+* {{ template "note" .}}
+{{ end -}}
+{{- end -}}
+
+{{- if .NotesByType.security }}
+SECURITY:
+
+{{range .NotesByType.security -}}
+* {{ template "note" .}}
+{{ end -}}
+{{- end -}}
+
+{{- if .NotesByType.deprecation -}}
+DEPRECATIONS:
+
+{{range .NotesByType.deprecation -}}
+* {{ template "note" .}}
+{{ end -}}
+{{- end -}}
+
+{{- if .NotesByType.feature }}
+FEATURES:
+
+{{range .NotesByType.feature -}}
+* {{ template "note" . }}
+{{ end -}}
+{{- end -}}
+
+{{- $improvements := combineTypes .NotesByType.improvement .NotesByType.enhancement -}}
+{{- if $improvements }}
+IMPROVEMENTS:
+
+{{range $improvements | sort -}}
+* {{ template "note" . }}
+{{ end -}}
+{{- end -}}
+
+{{- if .NotesByType.bug }}
+BUG FIXES:
+
+{{range .NotesByType.bug -}}
+* {{ template "note" . }}
+{{ end -}}
+{{- end -}}
+
+{{- if .NotesByType.note -}}
+NOTES:
+
+{{range .NotesByType.note -}}
+* {{ template "note" .}}
+{{ end -}}
+{{- end -}}

.changelog/release-note.tmpl

@@ -0,0 +1,3 @@
+{{- define "note" -}}
+{{.Body}}{{if not (stringHasPrefix .Issue "_")}} [[GH-{{- .Issue -}}](https://github.com/hashicorp/consul-api-gateway/issues/{{- .Issue -}})]{{end}}
+{{- end -}}

.changelog/types.txt

@@ -0,0 +1,7 @@
+breaking-change
+security
+deprecation
+feature
+enhancement
+bug
+note

.github/pull_request_template.md

@@ -7,5 +7,4 @@
 ### Checklist:
 - [ ] Tests added
 - [ ] CHANGELOG entry added 
-  > HashiCorp engineers only, community PRs should not add a changelog entry.
   > Entries should use imperative present tense (e.g. Add support for...)

.github/workflows/changelog.yml

@@ -0,0 +1,42 @@
+# This workflow checks that there is either a 'pr/no-changelog' label applied to a PR
+# or there is a .changelog/<pr_number>.txt file containing a changelog entry with
+# one or more valid changelog notes
+name: changelog
+on:
+  pull_request:
+    types: [opened, synchronize, labeled]
+    # Runs on PRs to main and all release branches
+    branches:
+      - main
+      - release/*
+
+jobs:
+  validate:
+    # If there  a `pr/no-changelog` label we ignore this check
+    if: "!contains(github.event.pull_request.labels.*.name, 'pr/no-changelog')"
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v2
+        with:
+          ref: ${{ github.event.pull_request.head.sha }}
+          fetch-depth: 0 # by default the checkout action doesn't checkout all branches
+      # Go 1.16 or later needed for building changelog-check from source
+      - uses: ./.github/actions/goenv
+        with:
+          go-version: '1.17'
+      - name: Check for changelog entry in diff
+        run: |
+          pull_request_base_main=$(expr "${{ github.event.pull_request.base.ref }}" = "main")
+
+          # For PRs against the main branch, the changelog file name should match
+          # the PR number
+          if [ pull_request_base_main ]; then
+            enforce_matching=1
+            changelog_file_path=".changelog/${{ github.event.pull_request.number }}.txt"
+          else
+            changelog_file_path=".changelog/*(_)+([[:digit:]]).txt"
+          fi
+
+          # Fail status check if non-zero exit code is returned
+          ./scripts/changelog-check.sh ${changelog_file_path} ${enforce_matching}

.gitignore

@@ -8,3 +8,4 @@ cover.out
 demo-deployment
 bin
 pkg/bin
+go-changelog/

Makefile

@@ -50,6 +50,33 @@ endif
 test:
 	go test ./...
 
+.PHONY: changelog
+changelog:
+ifeq (, $(shell which changelog-build))
+	@go install github.com/hashicorp/go-changelog/cmd/changelog-build@latest
+endif
+ifeq (, $(LAST_RELEASE_GIT_TAG))
+	@echo "Please set the LAST_RELEASE_GIT_TAG environment variable to generate a changelog section of notes since the last release."
+else
+	changelog-build -last-release ${LAST_RELEASE_GIT_TAG} -entries-dir .changelog/ -changelog-template .changelog/changelog.tmpl -note-template .changelog/release-note.tmpl -this-release $(shell git rev-parse HEAD)
+endif
+
+.PHONY: changelog-entry
+changelog-entry:
+ifeq (, $(shell which changelog-entry))
+	@go install github.com/hashicorp/go-changelog/cmd/changelog-entry@latest
+endif
+	changelog-entry -dir .changelog
+
+.PHONY: changelog-check
+changelog-check:
+ifeq (, $(shell which changelog-check))
+	@rm -rf go-changelog
+	@git clone -b changelog-check https://github.com/mikemorris/go-changelog
+	@cd go-changelog && go install ./cmd/changelog-check
+endif
+	@changelog-check
+
 # Run controller tests
 .PHONY: ctrl-test
 ENVTEST_ASSETS_DIR=$(shell pwd)/testbin

changelog-check.sh

@@ -0,0 +1,29 @@
+#!/usr/bin/env bash
+
+set -e
+
+changelog_file_path=$1
+
+if [ -n "$2" ]; then
+  enforce_matching_pull_request_number="matching this PR number "
+fi
+
+# Check if there is a diff matching the expected changelog file path
+changelog_files=$(git --no-pager diff --name-only HEAD "$(git merge-base HEAD "origin/main")" -- ${changelog_file_path})
+
+# Exit with error if no changelog entry is found
+if [ -z "$changelog_files" ]; then
+  echo "Did not find a changelog entry ${enforce_matching_pull_request_number}and the 'pr/no-changelog' label was not applied. Reference - https://github.com/hashicorp/consul/pull/8387"
+  exit 1
+fi
+
+# Validate format with make changelog-check, exit with error if any note has an
+# invalid format
+for file in $changelog_files; do
+  if ! cat $file | make changelog-check; then
+    echo "Found a changelog entry ${enforce_matching_pull_request_number}but the note format in ${file} was invalid."
+    exit 1
+  fi
+done
+
+echo "Found valid changelog entry!"

scripts/changelog-check.sh

@@ -0,0 +1,30 @@
+#!/usr/bin/env bash
+
+set -e
+shopt -s extglob
+
+changelog_file_path=$1
+
+if [ ! -z "$2" ]; then
+  enforce_matching_pull_request_number="matching this PR number "
+fi
+
+# Check if there is a diff matching the expected changelog file path
+changelog_files=$(git --no-pager diff --name-only HEAD "$(git merge-base HEAD "origin/main")" -- ${changelog_file_path})
+
+# Exit with error if no changelog entry is found
+if [ -z "$changelog_files" ]; then
+  echo "Did not find a changelog entry ${enforce_matching_pull_request_number}and the 'pr/no-changelog' label was not applied. Reference - https://github.com/hashicorp/consul/pull/8387"
+  exit 1
+fi
+
+# Validate format with make changelog-check, exit with error if any note has an
+# invalid format
+for file in $changelog_files; do
+  if ! cat $file | make changelog-check; then
+    echo "Found a changelog entry ${enforce_matching_pull_request_number}but the note format in ${file} was invalid."
+    exit 1
+  fi
+done
+
+echo "Found valid changelog entry!"