Add changelog (#12)

Author: boxofrad

.changelog/changelog.tmpl

@@ -0,0 +1,57 @@
+{{- 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.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.deprecation }}
+DEPRECATIONS:
+
+{{range .NotesByType.deprecation -}}
+* {{ 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/note.tmpl

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

.github/workflows/changelog-checker.yml

@@ -0,0 +1,48 @@
+# 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 associated with a PR for a changelog entry
+
+name: Changelog Checker
+
+on:
+  pull_request:
+    types: [opened, synchronize, labeled]
+    # Runs on PRs to main and all release branches
+    branches:
+      - main
+      - release/*
+
+jobs:
+  # checks that a .changelog entry is present for a PR
+  changelog-check:
+    # 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
+      - name: Check for changelog entry in diff
+        run: |
+          pull_request_base_main=$(expr "${{ github.event.pull_request.base.ref }}" = "main")
+
+          # check if there is a diff in the .changelog directory
+          # for PRs against the main branch, the changelog file name should match the PR number
+          if [ pull_request_base_main ]; then
+            enforce_matching_pull_request_number="matching this PR number "
+            changelog_file_path=".changelog/${{ github.event.pull_request.number }}.txt"
+          else
+            changelog_file_path=".changelog/*.txt"
+          fi
+
+          changelog_files=$(git --no-pager diff --name-only HEAD "$(git merge-base HEAD "origin/main")" -- ${changelog_file_path})
+
+          # If we do not find a file in .changelog/, we fail the check
+          if [ -z "$changelog_files" ]; then
+            # Fail status check when no .changelog entry was found on the PR
+            echo "Did not find a .changelog entry ${enforce_matching_pull_request_number}and the 'pr/no-changelog' label was not applied."
+            exit 1
+          else
+            echo "Found .changelog entry in PR!"
+          fi

CHANGELOG.md

@@ -0,0 +1,3 @@
+## 0.1.0-beta (Unreleased)
+
+* Initial release.

Makefile

@@ -96,3 +96,16 @@ copy-bootstrap-config:
 .PHONY: unit-tests
 unit-tests:
 	go test ./...
+
+.PHONY: changelog
+changelog:
+ifdef LAST_RELEASE_GIT_TAG
+	changelog-build \
+		-last-release $(LAST_RELEASE_GIT_TAG) \
+		-entries-dir .changelog/ \
+		-changelog-template .changelog/changelog.tmpl \
+		-note-template .changelog/note.tmpl \
+		-this-release $(REVISION)
+else
+	$(error Cannot generate changelog without LAST_RELEASE_GIT_TAG)
+endif