Create draft release via GitHub CLI or UI

Author: avdv

.github/workflows/prepare-release.yaml

@@ -1,38 +1,49 @@
-name: Prepare release
+# Create a draft release when triggered via Github's UI or Github CLI
+name: Prepare Release
 
 on:
-  push:
-    tags:
-      - "v[0-9]*.[0-9]*"
+  workflow_dispatch:
+    inputs:
+      version:
+        description: 'Version to release (e.g. 0.11.0)'
+        required: true
+        type: string
+
+permissions:
+  contents: write
 
 jobs:
-  update-release-notes:
-    name: Update release
+  release:
+    name: Prepare Release
     runs-on: ubuntu-latest
     steps:
+      - name: Check version
+        run: |
+          if ! [[ '${{ inputs.version }}' =~ ^[0-9]+[.][0-9]+([.][0-9]+)?$ ]]; then
+             echo '${{ inputs.version }} does not match expected format `major.minor.patch?`' >&2
+             exit 1
+           fi
       - name: Checkout
         uses: actions/checkout@v4
-      - name: Create archive
-        id: archive
+        with:
+          ref: master           # only create releases from main branch
+      - name: Read section from CHANGELOG.md
+        id: extract-changelog
+        uses: sean0x42/markdown-extract@v2
+        with:
+         file: CHANGELOG.md
+         pattern: ${{ inputs.version }}
+      - name: Prepare release notes and artifacts
         run: |
-          TAG="${GITHUB_REF_NAME}"
-          REPOSITORY_NAME="${GITHUB_REPOSITORY#*/}"
-          PREFIX="${REPOSITORY_NAME}-${TAG:1}"
-          ARCHIVE="${PREFIX}.tar.gz"
-
-          echo "tgz=${ARCHIVE}" >> $GITHUB_OUTPUT
-
-          git archive --format=tar.gz --prefix="${PREFIX}/" -o "$ARCHIVE" "${TAG}"
-      - name: Prepare bzlmod / WORKSPACE snippets
-        run: .github/workflows/prepare_snippets.sh ${{ steps.archive.outputs.tgz }} > release_notes.txt
-      - name: Generate changelog
+          .github/workflows/release_prep.sh v${{ inputs.version }} > release_notes.txt
+          printf '${{ steps.extract-changelog.outputs.markdown }}' >> release_notes.txt
+      - name: Create draft release
+        env:
+          GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
         run: |
-          printf '\n-----\n\n' >> release_notes.txt
-          awk -f .github/workflows/changelog.awk CHANGELOG.md >> release_notes.txt
-      - name: Release
-        uses: softprops/action-gh-release@v2
-        with:
-          draft: true
-          body_path: release_notes.txt
-          fail_on_unmatched_files: true
-          files: ${{ steps.archive.outputs.tgz }}
+          gh release create \
+            --draft \
+            --notes-file release_notes.txt \
+            --title v${{ inputs.version }} \
+            v${{ inputs.version }} \
+            rules_nixpkgs-${{ inputs.version }}.tar.gz

.github/workflows/release_prep.sh

@@ -0,0 +1,40 @@
+#!/usr/bin/env bash
+set -euo pipefail
+
+TAG=$1
+REPO_NAME=${GITHUB_REPOSITORY#*/}
+# The prefix is chosen to match what GitHub generates for source archives
+PREFIX="${REPO_NAME}-${TAG:1}"
+ARCHIVE="${REPO_NAME}-${TAG:1}.tar.gz"
+git archive --format=tar.gz --prefix="${PREFIX}/" -o $ARCHIVE HEAD
+SHA=$(shasum -a 256 "$ARCHIVE" | awk '{print $1}')
+
+cat << EOF
+## Using Bzlmod with Bazel 6+
+
+1. Enable with \`common --enable_bzlmod\` in \`.bazelrc\`.
+2. Add to your \`MODULE.bazel\` file:
+
+\`\`\`starlark
+bazel_dep(name = "${REPO_NAME}", version = "${TAG:1}")
+\`\`\`
+
+## Using WORKSPACE
+
+Paste this snippet into your \`WORKSPACE.bazel\` file:
+
+\`\`\`starlark
+load("@bazel_tools//tools/build_defs/repo:http.bzl", "http_archive")
+
+http_archive(
+    name = "${REPO_NAME}",
+    sha256 = "${SHA}",
+    strip_prefix = "$PREFIX",
+    urls = ["https://github.com/$GITHUB_REPOSITORY/releases/download/$TAG/$ARCHIVE"],
+)
+
+load("@${REPO_NAME}//haskell:repositories.bzl", "${REPO_NAME}_dependencies")
+
+${REPO_NAME}_dependencies()
+\`\`\`
+EOF