Merge pull request #2024 from tweag/refine-release-workflow

Add tar.gz archive to each release

Author: mergify[bot]

.github/workflows/prepare-release.yaml

@@ -12,8 +12,19 @@ jobs:
     steps:
       - name: Checkout
         uses: actions/checkout@v4
-      - name: Prepare workspace snippet
-        run: .github/workflows/workspace_snippet.sh > release_notes.txt
+      - name: Create archive
+        id: archive
+        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
         run: |
           printf '\n-----\n\n' >> release_notes.txt
@@ -23,3 +34,5 @@ jobs:
         with:
           draft: true
           body_path: release_notes.txt
+          fail_on_unmatched_files: true
+          files: ${{ steps.archive.outputs.tgz }}

.github/workflows/workspace_snippet.sh renamed to .github/workflows/prepare_snippets.sh

@@ -2,20 +2,32 @@
 
 set -o errexit -o nounset -o pipefail
 
+ARCHIVE="$1"
+
 # Set by GH actions, see
 # https://docs.github.com/en/actions/learn-github-actions/environment-variables#default-environment-variables
 TAG=${GITHUB_REF_NAME}
 REPO_NAME=${GITHUB_REPOSITORY#*/}
 PREFIX="${REPO_NAME}-${TAG:1}"
-URL="https://github.com/${GITHUB_REPOSITORY}/archive/refs/tags/${TAG}.tar.gz"
+URL="https://github.com/${GITHUB_REPOSITORY}/releases/download/$TAG/$ARCHIVE"
 
-if ! SHA=$( curl -sfL "${URL}" | shasum -a 256 | awk '{print $1}'); then
-    echo "error: could not determine hash for ${URL}" >&2
+if ! SHA=$( shasum -a 256 "$ARCHIVE" | awk '{print $1}'); then
+    echo "error: could not determine hash for ${ARCHIVE}" >&2
     exit 1
 fi
 
 cat << EOF
-WORKSPACE snippet:
+## Using bzlmod with Bazel 6
+
+1. Enable with \`common --enable_bzlmod\` in \`.bazelrc\`.
+2. Add to your \`MODULE.bazel\` file:
+
+\`\`\`starlark
+bazel_dep(name = "rules_haskell", version = "${TAG:1}")
+\`\`\`
+
+## Using WORKSPACE
+
 \`\`\`starlark
 load("@bazel_tools//tools/build_defs/repo:http.bzl", "http_archive")
 http_archive(