Merge pull request #11 from kjanat/chore/release-notes-from-tag

Release with the tag's own message

Author: kjanat

.github/workflows/release.yml

@@ -31,6 +31,14 @@ jobs:
     permissions: { contents: write, id-token: write, attestations: write }
     steps:
       - uses: actions/checkout@v7
+      - name: Release notes from the tag message
+        run: |
+          git fetch --force origin "refs/tags/${GITHUB_REF_NAME}:refs/tags/${GITHUB_REF_NAME}"
+          git tag -l --format='%(contents:body)' "${GITHUB_REF_NAME}" > "${RUNNER_TEMP}/notes.md"
+          test -s "${RUNNER_TEMP}/notes.md" || {
+            echo "tag ${GITHUB_REF_NAME} carries no message body to release with" >&2
+            exit 1
+          }
       - uses: actions/download-artifact@v8
         with: { path: dist, merge-multiple: true }
       - name: Checksums
@@ -43,5 +51,6 @@ jobs:
         with:
           working_directory: dist
           files: "envctl-*\nSHA256SUMS"
+          body_path: ${{ runner.temp }}/notes.md
           generate_release_notes: true
           fail_on_unmatched_files: true

CONTRIBUTING.md

@@ -141,6 +141,11 @@ git tag -s v0.2.0 -m "v0.2.0"
 git push origin v0.2.0
 ```
 
+The tag's message body becomes the release notes, with the generated commit list
+appended below it, so write the tag for a reader who was not here. The first
+line is the version alone; everything after the blank line is published. An
+empty body fails the release job rather than shipping a bare commit list.
+
 [`.dprint.jsonc`]: .dprint.jsonc
 [`.clang-format`]: .clang-format
 [`tests/run.sh`]: tests/run.sh