Refactor release workflows (#3911)

vinistock · web-flow · commit 7eb2eb783063 · 2026-01-21T12:58:58.000-05:00
* Refactor release workflows

* Match VS Code's NodeJS version
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -13,7 +13,7 @@ jobs:
           DISABLE_V8_COMPILE_CACHE: "1"
         uses: actions/setup-node@6044e13b5dc448c55e2357c09f80417699197238 # v6.2.0
         with:
-          node-version: "22.15"
+          node-version: "22.21"
 
       - name: Run cspell
         run: |
@@ -72,7 +72,7 @@ jobs:
           DISABLE_V8_COMPILE_CACHE: "1"
         uses: actions/setup-node@6044e13b5dc448c55e2357c09f80417699197238 # v6.2.0
         with:
-          node-version: "22.15"
+          node-version: "22.21"
           cache: "yarn"
           cache-dependency-path: "vscode"
 
@@ -96,7 +96,7 @@ jobs:
         env:
           DISABLE_V8_COMPILE_CACHE: 1
         with:
-          node-version: "22.15"
+          node-version: "22.21"
           cache: "yarn"
           cache-dependency-path: "vscode"
 
diff --git a/.github/workflows/release_extension.yml b/.github/workflows/release_extension.yml
@@ -1,12 +1,13 @@
-name: Publish
+name: Release VS Code extension
 
 on:
-  release:
-    types: [published]
+  push:
+    tags:
+      - vscode-ruby-lsp-v[0-9]+.[0-9]+.[0-9]+(-preview)?
 
 jobs:
-  publish:
-    if: ${{ startsWith(github.ref, 'refs/tags/vscode-ruby-lsp') }}
+  release_extension:
+    if: github.repository == 'Shopify/ruby-lsp'
     runs-on: ubuntu-latest
 
     steps:
@@ -18,11 +19,74 @@ jobs:
         env:
           DISABLE_V8_COMPILE_CACHE: "1"
         with:
-          node-version: "22.15"
+          node-version: "22.21"
           cache: "yarn"
           cache-dependency-path: "vscode"
 
-      - name: Update release notes
+      - name: Create CHANGELOG.md
+        uses: actions/github-script@ed597411d8f924073f98dfc5c65a23a2325f34cd # v8.0.0
+        with:
+          github-token: "${{ secrets.GITHUB_TOKEN }}"
+          script: |
+            const fs = require("fs");
+
+            const { data: releases } = await github.rest.repos.listReleases({
+              owner: context.repo.owner,
+              repo: context.repo.repo,
+            });
+
+            const includePrereleases = context.payload.release.prerelease;
+
+            const changelog = releases
+              .filter((release) => release.tag_name.startsWith("vscode-ruby-lsp") && (includePrereleases || !release.prerelease))
+              .map((release) => `${release.body}\n`)
+              .join("\n");
+
+            fs.writeFileSync("vscode/CHANGELOG.md", changelog);
+
+      - name: Copy files needed for release
+        run: |
+          cp CODE_OF_CONDUCT.md vscode/CODE_OF_CONDUCT.md
+
+      - name: 📦 Install dependencies
+        working-directory: ./vscode
+        run: yarn --frozen-lockfile
+
+      # Stable releases
+      - name: Publish extension in the marketplace
+        if: ${{ !endsWith(github.ref_name, '-preview') }}
+        working-directory: ./vscode
+        run: |
+          yarn run package
+          node_modules/.bin/vsce publish --packagePath vscode-ruby-lsp.vsix
+        env:
+          VSCE_PAT: ${{ secrets.VSCE_PAT }}
+
+      # Prereleases
+      - name: Package and publish prerelease extension in the marketplace
+        if: ${{ endsWith(github.ref_name, '-preview') }}
+        working-directory: ./vscode
+        run: |
+          yarn run package_prerelease
+          node_modules/.bin/vsce publish --pre-release --packagePath vscode-ruby-lsp.vsix
+        env:
+          VSCE_PAT: ${{ secrets.VSCE_PAT }}
+
+      # Stable releases for OpenVSX
+      - name: Publish extension on OpenVSX
+        if: ${{ !endsWith(github.ref_name, '-preview') }}
+        working-directory: ./vscode
+        run: |
+          yarn run package
+          node_modules/.bin/ovsx publish vscode-ruby-lsp.vsix -p ${{ secrets.OPENVSX_TOKEN }} --yarn
+
+  release_github:
+    name: Create GitHub release
+    if: github.repository == 'Shopify/ruby-lsp'
+    needs: release_extension
+    runs-on: ubuntu-latest
+    steps:
+      - name: Create GitHub release
         uses: actions/github-script@ed597411d8f924073f98dfc5c65a23a2325f34cd # v8.0.0
         with:
           github-token: "${{ secrets.GITHUB_TOKEN }}"
@@ -88,72 +152,11 @@ jobs:
               content += `## 📦 Other Changes\n\n${otherChanges.map((pull) => `- ${pull.title} (${pull.url}) by @${pull.author}`).join("\n")}\n\n`;
             }
 
-            const releaseResponse = await github.rest.repos.getReleaseByTag({
-              owner: context.repo.owner,
-              repo: context.repo.repo,
-              tag: "${{ github.ref_name }}",
-            });
-
-            await github.rest.repos.updateRelease({
-              owner: context.repo.owner,
-              repo: context.repo.repo,
-              release_id: releaseResponse.data.id,
-              body: content
-            });
-
-      - name: Create CHANGELOG.md
-        uses: actions/github-script@ed597411d8f924073f98dfc5c65a23a2325f34cd # v8.0.0
-        with:
-          github-token: "${{ secrets.GITHUB_TOKEN }}"
-          script: |
-            const fs = require("fs");
-
-            const { data: releases } = await github.rest.repos.listReleases({
+            await github.rest.repos.createRelease({
               owner: context.repo.owner,
               repo: context.repo.repo,
+              tag_name: "${{ github.ref }}",
+              name: "${{ github.ref_name }}",
+              body: content,
+              prerelease: "${{ github.ref_name }}".endsWith("-preview")
             });
-
-            const includePrereleases = context.payload.release.prerelease;
-
-            const changelog = releases
-              .filter((release) => release.tag_name.startsWith("vscode-ruby-lsp") && (includePrereleases || !release.prerelease))
-              .map((release) => `${release.body}\n`)
-              .join("\n");
-
-            fs.writeFileSync("vscode/CHANGELOG.md", changelog);
-
-      - name: Copy files needed for release
-        run: |
-          cp CODE_OF_CONDUCT.md vscode/CODE_OF_CONDUCT.md
-
-      - name: 📦 Install dependencies
-        working-directory: ./vscode
-        run: yarn --frozen-lockfile
-
-      # Stable releases
-      - name: Publish extension in the marketplace
-        if: "!github.event.release.prerelease"
-        working-directory: ./vscode
-        run: |
-          yarn run package
-          node_modules/.bin/vsce publish --packagePath vscode-ruby-lsp.vsix
-        env:
-          VSCE_PAT: ${{ secrets.VSCE_PAT }}
-
-      # Prereleases
-      - name: Package and publish prerelease extension in the marketplace
-        if: "github.event.release.prerelease"
-        working-directory: ./vscode
-        run: |
-          yarn run package_prerelease
-          node_modules/.bin/vsce publish --pre-release --packagePath vscode-ruby-lsp.vsix
-        env:
-          VSCE_PAT: ${{ secrets.VSCE_PAT }}
-
-      # Stable releases for OpenVSX
-      - name: Publish extension on OpenVSX
-        if: "!github.event.release.prerelease"
-        working-directory: ./vscode
-        run: |
-          yarn run package
-          node_modules/.bin/ovsx publish vscode-ruby-lsp.vsix -p ${{ secrets.OPENVSX_TOKEN }} --yarn
diff --git a/.github/workflows/release_gem.yml b/.github/workflows/release_gem.yml
@@ -1,17 +1,48 @@
-name: Release
+name: Release gem on RubyGems.org and create GitHub release
 
 on:
   push:
     tags:
       - v[0-9]+.[0-9]+.[0-9]+
 
 jobs:
-  publish:
+  release_gem:
+    name: Release gem on RubyGems.org
+    if: github.repository == 'Shopify/ruby-lsp'
     runs-on: ubuntu-latest
 
+    permissions:
+      contents: write
+      id-token: write
+
+    environment: release
+
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@8e8c483db84b4bee98b60c0593521ed34d9990e8 # v6.0.1
+        with:
+          persist-credentials: false
+
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@80740b3b13bf9857e28854481ca95a84e78a2bdf # v1.284.0
+        with:
+          bundler-cache: true
+
+      - name: Release gem on RubyGems.org
+        uses: rubygems/release-gem@1c162a739e8b4cb21a676e97b087e8268d8fc40b # v1.1.2
+
+  release_github:
+    name: Create GitHub release
+    if: github.repository == 'Shopify/ruby-lsp'
+    needs: release_gem
+    runs-on: ubuntu-latest
+
+    permissions:
+      contents: write
+
     steps:
-      - uses: actions/checkout@8e8c483db84b4bee98b60c0593521ed34d9990e8 # v6.0.1
-        name: Checkout
+      - name: Checkout repository
+        uses: actions/checkout@8e8c483db84b4bee98b60c0593521ed34d9990e8 # v6.0.1
 
       - name: Create release
         uses: actions/github-script@ed597411d8f924073f98dfc5c65a23a2325f34cd # v8.0.0
diff --git a/.github/workflows/version_bump.yml b/.github/workflows/version_bump.yml
diff --git a/dev.yml b/dev.yml
@@ -9,7 +9,7 @@ up:
   - bundler
   - node:
       yarn: true
-      version: 22.15.1
+      version: 22.21.1
       packages:
         - vscode
   - packages:
