ci: update release candidate in pull request when changes are available (#552)

zimeg · web-flow · commit dd404fe3d719 · 2026-05-21T15:44:28.000-07:00
diff --git a/.circleci/config.yml b/.circleci/config.yml
@@ -272,49 +272,34 @@ jobs:
               done
             fi
       - run:
-          name: "Update release description and upload assets to GitHub"
+          name: "Upload assets to GitHub release"
           command: |
-            # Replace double quotes with single quotes
             RELEASE_ID=$(curl -H "Accept: application/vnd.github+json" -H "Authorization: token $GITHUB_RELEASE_TOKEN" "https://api.github.com/repos/slackapi/slack-cli/releases/tags/$RELEASE_REF" | jq -r .id);
-            PRERELEASE="true";
-            TARGET="${CIRCLE_SHA1}";
-            if [ "<< parameters.production >>" != "false" ];
-            then
-              PRERELEASE="false";
-              TARGET="main";
-            fi
-            BODY="{\"tag_name\":\"${RELEASE_REF}\",\"name\":\"${RELEASE_REF}\",\"target_commitish\":\"${TARGET}\",\"draft\":false,\"prerelease\":${PRERELEASE},"
 
             if [ "$RELEASE_ID" = "null" ]; then
-              BODY+="\"generate_release_notes\":true}"
-              echo "Creating a new GitHub release with: ${BODY}"
-              RELEASE_ID=$(curl -X POST -H "Accept: application/vnd.github+json" -H "Authorization: token $GITHUB_RELEASE_TOKEN" https://api.github.com/repos/slackapi/slack-cli/releases -d "${BODY}" | jq -r .id)
-              echo "... complete. RELEASE_ID=${RELEASE_ID}"
-            else
-              echo "Overwriting existing GitHub Release data; generating pre-release notes ..."
+              PRERELEASE="true"
+              TARGET="${CIRCLE_SHA1}"
+              if [ "<< parameters.production >>" != "false" ]; then
+                PRERELEASE="false"
+                TARGET="main"
+              fi
+              echo "Creating GitHub release for $RELEASE_REF..."
+              RELEASE_ID=$(curl -X POST -H "Accept: application/vnd.github+json" -H "Authorization: token $GITHUB_RELEASE_TOKEN" https://api.github.com/repos/slackapi/slack-cli/releases -d "{\"tag_name\":\"${RELEASE_REF}\",\"name\":\"${RELEASE_REF}\",\"target_commitish\":\"${TARGET}\",\"draft\":false,\"prerelease\":${PRERELEASE},\"generate_release_notes\":true}" | jq -r .id)
+            elif [ "<< parameters.production >>" = "false" ]; then
               LAST_SEMVER_TAG=$(git describe --tags --match 'v*.*.*' --abbrev=0 | cut -d"-" -f1)
-              # When generating release notes, setting the target tag_name property to an existing tag has GitHub ignore the target_commitish property
-              # So, set the tag name to the target commit to generate release notes from the last semver tag to the target commit
-              # See https://docs.github.com/en/rest/releases/releases?apiVersion=2022-11-28#generate-release-notes-content-for-a-release--parameters
-              # Note the following _does not change releases or tags_ - it only creates release notes, just like clicking "Generate Release Notes" on the GitHub Releases page.
-              CHANGELOG=$(curl -L -X POST -H "Accept: application/vnd.github+json" -H "Authorization: Bearer $GITHUB_RELEASE_TOKEN" -H "X-GitHub-Api-Version: 2022-11-28" https://api.github.com/repos/slackapi/slack-cli/releases/generate-notes -d "{\"tag_name\":\"${TARGET}\",\"target_commitish\":\"${TARGET}\",\"previous_tag_name\":\"${LAST_SEMVER_TAG}\"}" | jq .body)
-              echo "Will use release notes: ${CHANGELOG}"
-              BODY+="\"body\":$CHANGELOG}"
-              echo "Updating existing GitHub pre-release ${RELEASE_ID} with ${BODY}"
-              curl -X PATCH -H "Accept: application/vnd.github+json" -H "Authorization: token $GITHUB_RELEASE_TOKEN" https://api.github.com/repos/slackapi/slack-cli/releases/$RELEASE_ID -d "${BODY}"
-              echo "... complete."
+              CHANGELOG=$(curl -L -X POST -H "Accept: application/vnd.github+json" -H "Authorization: Bearer $GITHUB_RELEASE_TOKEN" -H "X-GitHub-Api-Version: 2022-11-28" https://api.github.com/repos/slackapi/slack-cli/releases/generate-notes -d "{\"tag_name\":\"${CIRCLE_SHA1}\",\"target_commitish\":\"${CIRCLE_SHA1}\",\"previous_tag_name\":\"${LAST_SEMVER_TAG}\"}" | jq .body)
+              curl -X PATCH -H "Accept: application/vnd.github+json" -H "Authorization: token $GITHUB_RELEASE_TOKEN" https://api.github.com/repos/slackapi/slack-cli/releases/$RELEASE_ID -d "{\"tag_name\":\"${RELEASE_REF}\",\"name\":\"${RELEASE_REF}\",\"target_commitish\":\"${CIRCLE_SHA1}\",\"draft\":false,\"prerelease\":true,\"body\":$CHANGELOG}"
             fi
 
-            binaries=`find << parameters.artifact_dir >>/slack_* -maxdepth 1 -not -type d`
-            for binary in $binaries
-            do
+            binaries=$(find << parameters.artifact_dir >>/slack_* -maxdepth 1 -not -type d)
+            for binary in $binaries; do
               curl -X POST \
-              -H "Authorization: token $GITHUB_RELEASE_TOKEN" \
-              -H "Accept: application/vnd.github.v3+json" \
-              -H "Content-Type: $(file -b --mime-type ${binary})" \
-              -H "Content-Length: $(wc -c <${binary} | xargs)" \
-              -T "${binary}" \
-              "https://uploads.github.com/repos/slackapi/slack-cli/releases/$RELEASE_ID/assets?name=$(basename ${binary})" | cat
+                -H "Authorization: token $GITHUB_RELEASE_TOKEN" \
+                -H "Accept: application/vnd.github.v3+json" \
+                -H "Content-Type: $(file -b --mime-type ${binary})" \
+                -H "Content-Length: $(wc -c <${binary} | xargs)" \
+                -T "${binary}" \
+                "https://uploads.github.com/repos/slackapi/slack-cli/releases/$RELEASE_ID/assets?name=$(basename ${binary})" | cat
             done
       - store_artifacts:
           path: << parameters.artifact_dir >>
diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml
@@ -0,0 +1,136 @@
+name: Release
+
+on:
+  push:
+    branches:
+      - main
+  workflow_dispatch:
+
+concurrency: ${{ github.workflow }}-${{ github.ref }}
+
+jobs:
+  rc:
+    name: RC
+    runs-on: ubuntu-latest
+    permissions:
+      contents: write
+      pull-requests: write
+    steps:
+      - name: Gather credentials
+        id: credentials
+        uses: actions/create-github-app-token@bcd2ba49218906704ab6c1aa796996da409d3eb1 # v3.2.0
+        with:
+          app-id: ${{ secrets.GH_APP_ID_RELEASER }}
+          private-key: ${{ secrets.GH_APP_PRIVATE_KEY_RELEASER }}
+
+      - name: Checkout repo
+        uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2
+        with:
+          fetch-depth: 0
+          persist-credentials: true
+          ref: main
+          token: ${{ steps.credentials.outputs.token }}
+
+      - name: Set up Go
+        uses: actions/setup-go@4a3601121dd01d1626a1e23e37211e3254c1c06c # v6.4.0
+        with:
+          go-version-file: go.mod
+
+      - name: Decide next version
+        id: version
+        env:
+          GH_TOKEN: ${{ steps.credentials.outputs.token }}
+        run: |
+          # Get the latest release tag
+          LATEST_TAG=$(git describe --tags --match 'v*.*.*' --abbrev=0)
+
+          # Get PR numbers since latest tag
+          PR_NUMBERS=$(git log "${LATEST_TAG}..HEAD" --oneline | grep -oP '#\K[0-9]+' || true)
+
+          if [ -z "$PR_NUMBERS" ]; then
+            echo "No new PRs since $LATEST_TAG"
+            echo "has_changes=false" >> "$GITHUB_OUTPUT"
+            exit 0
+          fi
+
+          # Search for highest semver label
+          SEMVER="patch"
+          for PR in $PR_NUMBERS; do
+            LABELS=$(gh pr view "$PR" --json labels --jq '.labels[].name' 2>/dev/null || true)
+            if echo "$LABELS" | grep -q "semver:major"; then
+              SEMVER="major"
+              break
+            elif echo "$LABELS" | grep -q "semver:minor"; then
+              SEMVER="minor"
+            fi
+          done
+
+          # Parse current version
+          VERSION="${LATEST_TAG#v}"
+          MAJOR=$(echo "$VERSION" | cut -d. -f1)
+          MINOR=$(echo "$VERSION" | cut -d. -f2)
+          PATCH=$(echo "$VERSION" | cut -d. -f3)
+
+          # Compute next version
+          case "$SEMVER" in
+            major)
+              NEXT_VERSION="$((MAJOR + 1)).0.0"
+              ;;
+            minor)
+              NEXT_VERSION="${MAJOR}.$((MINOR + 1)).0"
+              ;;
+            patch)
+              NEXT_VERSION="${MAJOR}.${MINOR}.$((PATCH + 1))"
+              ;;
+          esac
+
+          echo "has_changes=true" >> "$GITHUB_OUTPUT"
+          echo "next=$NEXT_VERSION" >> "$GITHUB_OUTPUT"
+          echo "semver=$SEMVER" >> "$GITHUB_OUTPUT"
+          echo "Bumping $LATEST_TAG to v$NEXT_VERSION"
+
+      - name: Generate release commit
+        if: steps.version.outputs.has_changes == 'true'
+        env:
+          RELEASE_VERSION: ${{ steps.version.outputs.next }}
+        run: |
+          git config user.name "slack-cli-releaser[bot]"
+          git config user.email "122933866+slack-cli-releaser[bot]@users.noreply.github.com"
+          make tag RELEASE_VERSION="$RELEASE_VERSION"
+          git push origin "HEAD:refs/heads/rc" --force
+
+      - name: Create or update release PR
+        if: steps.version.outputs.has_changes == 'true'
+        env:
+          GH_TOKEN: ${{ steps.credentials.outputs.token }}
+          RELEASE_VERSION: ${{ steps.version.outputs.next }}
+          SEMVER: ${{ steps.version.outputs.semver }}
+        run: |
+          PR_TITLE="chore: release slack-cli v${RELEASE_VERSION}"
+          PR_BODY=$(cat <<EOF
+          ### Summary
+
+          Release v${RELEASE_VERSION}. After merging, create a [GitHub Release](https://github.com/${{ github.repository }}/releases/new?tag=v${RELEASE_VERSION}&title=v${RELEASE_VERSION}) to tag and trigger the release pipeline.
+
+          ### Testing
+
+          Install the [dev-build](https://github.com/slackapi/slack-cli/releases/tag/dev-build) and verify changes.
+
+          ### Requirements
+
+          - [x] I've read and understood the [Contributing Guidelines](https://github.com/slackapi/slack-cli/blob/main/.github/CONTRIBUTING.md) and have done my best effort to follow them.
+          - [x] I've read and agree to the [Code of Conduct](https://slackhq.github.io/code-of-conduct).
+          EOF
+          )
+
+          # Check if a PR from rc already exists
+          EXISTING_PR=$(gh pr list --head rc --base main --json number --jq '.[0].number' 2>/dev/null || true)
+
+          if [ -n "$EXISTING_PR" ]; then
+            gh pr edit "$EXISTING_PR" --remove-label "semver:patch" --remove-label "semver:minor" --remove-label "semver:major" 2>/dev/null || true
+            gh pr edit "$EXISTING_PR" --title "$PR_TITLE" --body "$PR_BODY" --milestone "Next Release" --label "release" --label "semver:${SEMVER}"
+            echo "Updated PR #$EXISTING_PR"
+          else
+            gh pr create --head rc --base main --title "$PR_TITLE" --body "$PR_BODY" --milestone "Next Release" --label "release" --label "semver:${SEMVER}"
+            echo "Created new release PR"
+          fi
diff --git a/Makefile b/Makefile
@@ -73,18 +73,18 @@ build-ci: clean
 build-snapshot: clean
 	BUILD_VERSION="$(BUILD_VERSION)" LDFLAGS="$(LDFLAGS)" go tool goreleaser --snapshot --clean --skip=publish --config .goreleaser.yml
 
-# Update documentation in a commit tagged as the release
-# Usage: `make tag RELEASE_VERSION=3.7.0-example`
-.PHONY: tag
-tag:
+# Create a release candidate commit with updated docs
+# Usage: `make rc RELEASE_VERSION=3.7.0-example`
+.PHONY: rc
+rc:
 	git diff --quiet --cached
 	git diff --quiet
 	@if echo "$(RELEASE_VERSION)" | grep -q '^v'; then \
 		echo "Error: Release version should not begin with a version prefix."; \
 		exit 1; \
 	fi
-	@printf "$(FONT_BOLD)Creating Branch$(FONT_RESET)\n"
-	git checkout -b "chore-release-$(RELEASE_VERSION)"
+	@printf "$(FONT_BOLD)Building CLI$(FONT_RESET)\n"
+	$(MAKE) build-ci LDFLAGS="-X 'github.com/slackapi/slack-cli/internal/version.Version=v$(RELEASE_VERSION)'"
 	@printf "$(FONT_BOLD)Updating Docs$(FONT_RESET)\n"
 	rm -rf ./docs/reference/commands ./docs/reference/errors.md
 	./bin/slack docgen ./docs/reference --skip-update
@@ -103,5 +103,3 @@ tag:
 	git add docs/guides/installing-the-slack-cli-for-windows.md
 	@printf "$(FONT_BOLD)Git Commit$(FONT_RESET)\n"
 	git commit -m "chore: release slack-cli v$(RELEASE_VERSION)"
-#	@printf "$(FONT_BOLD)Git Tag$(FONT_RESET)\n"
-#	git tag v$(RELEASE_VERSION)
