Release tooling: Release stable releases from latest-release

.github/workflows/prepare-patch-release.yml → .github/workflows/prepare-hotfix-release.yml

@@ -16,8 +16,8 @@ concurrency:
   cancel-in-progress: true
 
 jobs:
-  prepare-patch-pull-request:
-    name: Prepare patch pull request
+  prepare-hotfix-pull-request:
+    name: Prepare hotfix pull request
     runs-on: ubuntu-latest
     environment: release
     defaults:
@@ -56,7 +56,7 @@ jobs:
         id: check-frozen
         env:
           GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-        run: yarn release:is-pr-frozen --patch
+        run: yarn release:is-pr-frozen --hotfix
 
       - name: Cancel when frozen
         if: steps.check-frozen.outputs.frozen == 'true' && github.event_name != 'workflow_dispatch'
@@ -88,6 +88,15 @@ jobs:
           git config --global user.email '[email protected]'
           yarn release:pick-patches
 
+      - name: Cancel when no hotfixes to pick
+        if: steps.pick-patches.outputs.pr-count == '0' && steps.pick-patches.outputs.pr-count != null
+        env:
+          GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        # From https://stackoverflow.com/a/75809743
+        run: |
+          gh run cancel ${{ github.run_id }}
+          gh run watch ${{ github.run_id }}
+
       - name: Bump version deferred
         id: bump-version
         if: steps.unreleased-changes.outputs.has-changes-to-release == 'true'
@@ -121,7 +130,7 @@ jobs:
           git config --global user.email '[email protected]'
           git checkout -b version-patch-from-${{ steps.versions.outputs.current }}
           git add .
-          git commit -m "Write changelog for ${{ steps.versions.outputs.next }}" || true
+          git commit -m "Write changelog for ${{ steps.versions.outputs.next }} [skip ci]" || true
           git push --force origin version-patch-from-${{ steps.versions.outputs.current }}
 
       - name: Generate PR description

.github/workflows/prepare-prerelease.yml → .github/workflows/prepare-next-release.yml

@@ -34,7 +34,7 @@ concurrency:
   cancel-in-progress: true
 
 jobs:
-  prepare-prerelease-pull-request:
+  prepare-next-pull-request:
     name: Prepare prerelease pull request
     runs-on: ubuntu-latest
     environment: release
@@ -112,21 +112,35 @@ jobs:
         run: |
           yarn release:version --deferred --release-type ${{ inputs.release-type || 'prerelease' }} ${{ inputs.pre-id && format('{0} {1}', '--pre-id', inputs.pre-id) || '' }} --verbose
 
+      - name: Check release vs prerelease
+        id: is-prerelease
+        run: yarn release:is-prerelease ${{ steps.bump-version.outputs.next-version }}
+
       - name: Write changelog
         env:
           GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
         run: |
           yarn release:write-changelog ${{ steps.bump-version.outputs.next-version }} --verbose
 
-      - name: 'Commit changes to branch: version-prerelease-from-${{ steps.bump-version.outputs.current-version }}'
+      - name: 'Commit changes to branch: version-next-from-${{ steps.bump-version.outputs.current-version }}'
         working-directory: .
         run: |
           git config --global user.name 'storybook-bot'
           git config --global user.email '[email protected]'
-          git checkout -b version-prerelease-from-${{ steps.bump-version.outputs.current-version }}
+          git checkout -b version-next-from-${{ steps.bump-version.outputs.current-version }}
+          git add .
+          git commit -m "Write changelog for ${{ steps.bump-version.outputs.next-version }} [skip ci]" || true
+          git push --force origin version-next-from-${{ steps.bump-version.outputs.current-version }}
+
+      - name: Resolve merge-conflicts with base branch
+        if: steps.is-prerelease.outputs.prerelease == 'true'
+        env:
+          GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        run: |
+          git pull origin latest-release
+          git checkout --ours .
           git add .
-          git commit -m "Write changelog for ${{ steps.bump-version.outputs.next-version }}" || true
-          git push --force origin version-prerelease-from-${{ steps.bump-version.outputs.current-version }}
+          git commit -m "Merge latest-release into version-next-from-${{ steps.bump-version.outputs.current-version }} with conflicts resolved to ours [skip ci]"
 
       - name: Generate PR description
         id: description
@@ -144,14 +158,15 @@ jobs:
             gh pr edit \
               --repo "${{github.repository }}" \
               --title "Release: $CAPITALIZED_RELEASE_TYPE ${{ inputs.pre-id && format('{0} ', inputs.pre-id) }}${{ steps.bump-version.outputs.next-version }}" \
+              --base ${{ steps.is-prerelease.outputs.prerelease == 'true' && 'next-release' || 'latest-release' }} \
               --body "${{ steps.description.outputs.description }}"
           else
             gh pr create \
               --repo "${{github.repository }}"\
               --title "Release: $CAPITALIZED_RELEASE_TYPE ${{ inputs.pre-id && format('{0} ', inputs.pre-id) }}${{ steps.bump-version.outputs.next-version }}" \
               --label "release" \
-              --base next-release \
-              --head version-prerelease-from-${{ steps.bump-version.outputs.current-version }} \
+              --base ${{ steps.is-prerelease.outputs.prerelease == 'true' && 'next-release' || 'latest-release' }} \
+              --head version-next-from-${{ steps.bump-version.outputs.current-version }} \
               --body "${{ steps.description.outputs.description }}"
           fi
 

.github/workflows/publish.yml

@@ -36,6 +36,22 @@ jobs:
           gh run cancel ${{ github.run_id }}
           gh run watch ${{ github.run_id }}
 
+      - name: Cancel all release preparation runs
+        run: |
+          # Get a list of all running or pending release preparation runs
+          # combining both the prepare-hotfix-release.yml and prepare-next-release.yml workflows
+          RUNNING_RELEASE_PREPARATIONS=$(
+            {
+              gh run list --limit 50 --workflow=prepare-hotfix-release.yml --json databaseId,status
+              gh run list --limit 50 --workflow=prepare-next-release.yml --json databaseId,status
+            } | jq -rc '.[] | select(.status | contains("in_progress", "pending", "queued", "requested", "waiting")) | .databaseId'
+          )
+
+          # Loop through each run and pass it to the "gh run cancel" command
+          while IFS= read -r databaseId; do
+            gh run cancel "$databaseId"
+          done <<< "$RUNNING_RELEASE_PREPARATIONS"
+
       - name: Checkout ${{ github.ref_name }}
         uses: actions/checkout@v3
         with:
@@ -63,7 +79,6 @@ jobs:
           yarn install
 
       - name: Apply deferred version bump and commit
-        id: version-bump
         working-directory: .
         run: |
           CURRENT_VERSION=$(cat ./code/package.json | jq '.version')
@@ -122,12 +137,11 @@ jobs:
         run: git fetch --tags origin
 
       # when this is a patch release from main, label any patch PRs included in the release
-      # when this is a stable release from next, label ALL patch PRs found, as they will per definition be "patched" now
       - name: Label patch PRs as picked
-        if: github.ref_name == 'latest-release' || (steps.publish-needed.outputs.published == 'false' && steps.target.outputs.target == 'next' && !steps.is-prerelease.outputs.prerelease)
+        if: github.ref_name == 'latest-release'
         env:
           GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-        run: yarn release:label-patches ${{ steps.target.outputs.target == 'next' && '--all' || '' }}
+        run: yarn release:label-patches
 
       - name: Create GitHub Release
         if: steps.publish-needed.outputs.published == 'false'
@@ -151,16 +165,45 @@ jobs:
           git merge ${{ github.ref_name }}
           git push origin ${{ steps.target.outputs.target }}
 
+      # This step ensures that next is always one minor ahead of main
+      # this is needed when releasing a stable from next
+      # next will be at eg. 7.4.0-alpha.4, and main will be at 7.3.0
+      # then we release 7.4.0 by merging next to latest-release to main
+      # we then ensure here that next is bumped to 7.5.0 - without releasing it
+      # if this is a hotfix release bumping main to 7.3.1, next will not be touched because it's already ahead
+      - name: Ensure `next` is a minor version ahead of `main`
+        if: steps.target.outputs.target == 'main'
+        run: |
+          git checkout next
+          git pull
+
+          CODE_PKG_JSON=$(cat ../code/package.json)
+          VERSION_ON_NEXT=$(echo $CODE_PKG_JSON | jq --raw-output '.version')
+          VERSION_ON_MAIN="${{ steps.version.outputs.current-version }}"
+
+          # skip if next is already ahead of main
+          if NEXT_IS_AHEAD=$(npx semver --include-prerelease --range ">=$VERSION_ON_MAIN" "$VERSION_ON_NEXT" 2>/dev/null); then
+            return
+          fi
+
+          # temporarily set the version on next to be the same as main...
+          echo "$CODE_PKG_JSON" | jq --arg version "$VERSION_ON_MAIN" '.version = $version' > ../code/package.json
+          # ... then bump it by one minor
+          yarn release:version --release-type minor
+          git add ..
+          git commit -m "Bump next to be one minor ahead of main [skip ci]"
+          git push origin next
+
       - name: Sync CHANGELOG.md from `main` to `next`
-        if: github.ref_name == 'latest-release'
+        if: steps.target.outputs.target == 'main'
         working-directory: .
         run: |
           git fetch origin next
           git checkout next
           git pull
           git checkout origin/main ./CHANGELOG.md
           git add ./CHANGELOG.md
-          git commit -m "Update CHANGELOG.md for v${{ steps.version.outputs.current-version }} [skip ci]"
+          git commit -m "Update CHANGELOG.md for v${{ steps.version.outputs.current-version }} [skip ci]" || true
           git push origin next
 
       - name: Sync version JSONs from `next-release` to `main`
@@ -176,10 +219,6 @@ jobs:
           git commit -m "Update $VERSION_FILE for v${{ steps.version.outputs.current-version }}"
           git push origin main
 
-      - name: Overwrite main with next
-        if: steps.target.outputs.target == 'next' && steps.is-prerelease.outputs.prerelease == 'false'
-        run: git push --force origin next:main
-
       - name: Report job failure to Discord
         if: failure()
         env: