Fix automated release process

Author: stefanmaric

.github/workflows/publish-release.yml

@@ -0,0 +1,30 @@
+name: Publish Release
+
+on:
+  push:
+    branches: [next]
+
+permissions:
+  contents: write
+
+concurrency:
+  group: publish-release
+  cancel-in-progress: false
+
+jobs:
+  publish-release:
+    name: Publish release
+    runs-on: ubuntu-24.04
+
+    env:
+      GH_TOKEN: ${{ github.token }}
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v6
+        with:
+          fetch-depth: 0
+          fetch-tags: true
+
+      - name: Publish release when current commit is a release
+        run: make publish-release

.github/workflows/release.yml

@@ -10,6 +10,7 @@ on:
 
 permissions:
   contents: write
+  pull-requests: write
 
 concurrency:
   group: release
@@ -30,7 +31,7 @@ jobs:
         with:
           fetch-depth: 0
 
-      - name: Create release
+      - name: Create release pull request
         env:
           RELEASE_DATE: ${{ github.run_started_at }}
         run: make release VERSION='${{ inputs.version }}'

CHANGELOG.md

@@ -24,6 +24,7 @@
 - Add automated release process
 - Ensure smoke tests use local scripts for bootstrap URLs
 - Improve install and download output layouts
+- Fix automated release process
 
 ## 0.10.0 - 2023-06-10
 

Makefile

@@ -40,6 +40,10 @@ test: prepare
 release:
 	@sh bin/release '$(VERSION)'
 
+.PHONY: publish-release
+publish-release:
+	@sh bin/publish-release
+
 .tmp/shellcheck:
 	@echo "Downloading shellcheck"
 	@echo

bin/publish-release

@@ -0,0 +1,118 @@
+#!/bin/sh
+
+set -o errexit
+set -o nounset
+
+die() {
+  printf '%s\n' "$1" >&2
+  exit 1
+}
+
+require_command() {
+  command -v "$1" > /dev/null 2>&1 || die "missing required command: $1"
+}
+
+repository() {
+  if [ -n "${GITHUB_REPOSITORY:-}" ]; then
+    printf '%s\n' "$GITHUB_REPOSITORY"
+    return
+  fi
+
+  gh repo view --json nameWithOwner --jq .nameWithOwner
+}
+
+validate_version() {
+  case "$1" in
+    *[!0-9.]* | .* | *. | *..* | "") return 1 ;;
+  esac
+
+  printf '%s\n' "$1" | grep -Eq '^[0-9]+\.[0-9]+\.[0-9]+$'
+}
+
+current_g_version() {
+  awk '
+    /^display_g_version\(\) \{$/ { in_version = 1; next }
+    in_version && /^[[:space:]]*echo "[^"]+"$/ {
+      sub(/^[[:space:]]*echo "/, "")
+      sub(/"$/, "")
+      print
+      exit
+    }
+  ' bin/g
+}
+
+validate_release_commit() {
+  g_version=$(current_g_version)
+
+  [ "$g_version" = "$version" ] \
+    || die "bin/g version is $g_version, expected $version"
+
+  grep "^## $version - " CHANGELOG.md > /dev/null \
+    || die "CHANGELOG.md does not contain release $version"
+
+  if git rev-parse -q --verify "refs/tags/$version" > /dev/null; then
+    die "tag already exists: $version"
+  fi
+
+  if gh release view "$version" > /dev/null 2>&1; then
+    die "release already exists: $version"
+  fi
+}
+
+write_release_notes() {
+  awk -v version="$version" '
+    index($0, "## " version " - ") == 1 { in_section = 1; next }
+    in_section && /^## / { exit }
+    in_section { print }
+  ' CHANGELOG.md > release-notes.md
+
+  awk 'index($0, "- ") == 1 { found = 1 } END { exit !found }' release-notes.md \
+    || die "release notes are empty"
+
+  previous_tag=$(git describe --tags --abbrev=0)
+  repo=$(repository)
+  {
+    printf '\n'
+    printf 'See full changelog: https://github.com/%s/compare/%s...%s\n' \
+      "$repo" "$previous_tag" "$version"
+  } >> release-notes.md
+}
+
+tag_release() {
+  if [ -n "${GITHUB_ACTIONS:-}" ]; then
+    git \
+      -c user.name='github-actions[bot]' \
+      -c user.email='41898282+github-actions[bot]@users.noreply.github.com' \
+      tag -a "$version" -F release-notes.md
+  else
+    git tag -a "$version" -F release-notes.md
+  fi
+
+  git push origin "$version"
+}
+
+create_github_release() {
+  gh release create "$version" \
+    --title "$version" \
+    --notes-file release-notes.md \
+    --latest=false \
+    bin/g \
+    bin/install
+}
+
+require_command awk
+require_command gh
+require_command git
+require_command grep
+
+version=${1:-$(git log -1 --pretty=%s)}
+
+if ! validate_version "$version"; then
+  printf 'not a release commit: %s\n' "$version"
+  exit 0
+fi
+
+validate_release_commit
+write_release_notes
+tag_release
+create_github_release

bin/release

@@ -11,8 +11,7 @@ usage() {
   cat <<- EOF
   Usage: bin/release VERSION
 
-  Creates a release commit, annotated tag, and GitHub release for VERSION.
-  The GitHub release is not marked as latest automatically.
+  Creates a release branch and pull request for VERSION.
 EOF
 }
 
@@ -85,18 +84,25 @@ validate_version() {
 validate_release_request() {
   branch=$(current_branch)
   default=$(default_branch)
+  release_branch="release/$version"
 
   [ "$branch" = "$default" ] \
     || die "run releases from $default, not $branch"
 
   git diff --quiet -- bin/g CHANGELOG.md \
     || die "bin/g or CHANGELOG.md has uncommitted changes"
 
-  git rev-parse -q --verify "refs/tags/$version" > /dev/null \
-    && die "tag already exists: $version"
+  if git rev-parse -q --verify "refs/tags/$version" > /dev/null; then
+    die "tag already exists: $version"
+  fi
+
+  if gh release view "$version" > /dev/null 2>&1; then
+    die "release already exists: $version"
+  fi
 
-  gh release view "$version" > /dev/null 2>&1 \
-    && die "release already exists: $version"
+  if git ls-remote --exit-code --heads origin "$release_branch" > /dev/null 2>&1; then
+    die "release branch already exists: $release_branch"
+  fi
 }
 
 prepare_release_files() {
@@ -150,6 +156,7 @@ prepare_release_files() {
       }
     }
   ' bin/g > bin/g.tmp
+  chmod +x bin/g.tmp
   mv bin/g.tmp bin/g
 
   awk -v version="$version" '
@@ -173,28 +180,35 @@ prepare_release_files() {
 validate_release_files() {
   make format
   make lint
+}
+
+validate_source_files() {
+  make format
+  make lint
   make test
 }
 
-commit_and_tag_release() {
-  if [ -n "${GITHUB_ACTIONS:-}" ]; then
-    git config user.name 'github-actions[bot]'
-    git config user.email '41898282+github-actions[bot]@users.noreply.github.com'
-  fi
+create_release_pr() {
+  release_branch="release/$version"
 
+  git checkout -B "$release_branch"
   git add bin/g CHANGELOG.md
-  git commit -m "$version"
-  git tag -a "$version" -F release-notes.md
-  git push origin "HEAD:$(current_branch)" "$version"
-}
 
-create_github_release() {
-  gh release create "$version" \
+  if [ -n "${GITHUB_ACTIONS:-}" ]; then
+    git \
+      -c user.name='github-actions[bot]' \
+      -c user.email='41898282+github-actions[bot]@users.noreply.github.com' \
+      commit -m "$version"
+  else
+    git commit -m "$version"
+  fi
+
+  git push --set-upstream origin "$release_branch"
+  gh pr create \
+    --base "$(default_branch)" \
+    --head "$release_branch" \
     --title "$version" \
-    --notes-file release-notes.md \
-    --latest=false \
-    bin/g \
-    bin/install
+    --body-file release-notes.md
 }
 
 version=${1:-}
@@ -218,7 +232,7 @@ require_command make
 
 validate_version "$version"
 validate_release_request
+validate_source_files
 prepare_release_files
 validate_release_files
-commit_and_tag_release
-create_github_release
+create_release_pr

tests/metadata.t

@@ -62,7 +62,7 @@ test_expect_success 'create mock Go archive' '
 
 test_expect_success 'g accepts exact GOPATH bin PATH entry' '
   output=$(run_with_path "$GOPATH/bin:$mock_path:/bin:/usr/bin" "$g_bin --version") &&
-  test "$output" = "0.10.0"
+  echo "$output" | grep -E "^[0-9]+\.[0-9]+\.[0-9]+$"
 '
 
 test_expect_success 'g rejects substring-only GOPATH bin PATH entry' '

tests/smoke.t

@@ -85,7 +85,7 @@ test_expect_success 'install script configures g' '
 
 test_expect_success 'g reports its version' '
   output=$(run_with_g_env "g --version") &&
-  test "$output" = "0.10.0"
+  echo "$output" | grep -E "^[0-9]+\.[0-9]+\.[0-9]+$"
 '
 
 test_expect_success 'go is installed by g and present on PATH' '