Switch to annotated tags for releases (#124)

Annotated tags conveniently facilitate bundling release notes. This changes the build process to require an annotated tag.

Author: FGasper

.github/workflows/release.yml

@@ -21,12 +21,25 @@ jobs:
     steps:
       - name: Checkout code
         uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+
+      # NB: actions/checkout quietly fetches all tags as lightweight tags,
+      # even if they’re annotated upstream. That, of course, prevents use
+      # of the tag message as release notes. This works around that.
+      #
+      # See https://github.com/actions/checkout/issues/290 for details.
+      - name: Fetch tags
+        run: git fetch --tags --force
 
       - name: Set up Go
         uses: actions/setup-go@v4
 
       - name: Build
         run: |
+          set -o errexit
+          TAG_NAME=$(git describe --exact-match)
+          git tag --list --format='%(contents)' "$TAG_NAME" > RELEASE-NOTES
           for target in $TARGETS; do
             export GOOS=${target%/*}
             export GOARCH=${target#*/}
@@ -39,4 +52,5 @@ jobs:
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
         with:
+          body_path: RELEASE-NOTES
           files: migration_verifier_*

RELEASE.md

@@ -1,16 +1,12 @@
 # Releasing Migration Verifier
 
-To release Migration Verifier, just create a lightweight git tag, thus:
+To release Migration Verifier, create an annotated git tag, thus:
 ```
-git tag v0.0.2
+git tag --annotate v0.0.2
 ```
-… and push it to upstream.
+The tag contents will be the release notes. See prior releases for the format.
+Once you’re done, push your tag to upstream. A pre-configured GitHub Action
+will create the release.
 
-Versions **MUST** start with a `v` and follow
+**IMPORTANT:** Versions **MUST** start with a `v` and follow
 [semantic versioning](https://semver.org/).
-
-An automated release process will build binaries and make them available
-for download. Check GitHub Actions for progress.
-
-Note that this process **DOES NOT** create release notes. Users should peruse
-the repository’s commit history for changes.