chore: reorganise GA to check and build once

himanshusinghs · himanshusinghs · commit 95acccee6cca · 2025-10-02T11:40:26.000+02:00
Earlier we were running check, build and tests on each OS in our matrix
which did not allow us to test whether a build on ubuntu would work fine
on Windows / MacOS or not.

With this commit we are re-organising to check and build once on ubuntu
and use the final artifact later in the test job to run tests against.

Accordingly the test-and-build-from-fork and draft-release workflows
have been modified to adapt the same change.
diff --git a/.github/workflows/draft-release.yaml b/.github/workflows/draft-release.yaml
@@ -1,34 +1,35 @@
+# Run manually to prepare a draft release for the next version of the extension.
+# The workflow will create a draft github release where the .vsix can be
+# downloaded and manually tested before publishing. To release the version,
+# publish the draft release, which will trigger the publish-release workflow.
 name: Draft release
 
 on:
   workflow_dispatch:
     inputs:
       versionBump:
-        description: 'Version bump'
+        description: "Version bump"
         type: choice
         required: true
-        default: 'patch'
+        default: "patch"
         options:
-        - patch
-        - minor
-        - major
-        - exact-version
+          - patch
+          - minor
+          - major
+          - exact-version
 
       exactVersion:
         description: 'Exact version: (Only effective selecting "exact-version" as version bump)'
         required: false
 
-description: |
-  Run manually to prepare a draft release for the next version of the extension. The workflow will create a draft
-  github release where the .vsix can be downloaded and manually tested before publishing. To release the version,
-  publish the draft release, which will trigger the publish-release workflow.
-
 permissions:
   contents: write
 
 jobs:
   prepare-release:
     runs-on: ubuntu-latest
+    outputs:
+      release-tag: ${{ steps.set-tag.outputs.release-tag }}
     steps:
       - name: Checkout
         uses: actions/checkout@v4
@@ -85,8 +86,40 @@ jobs:
             exit 1
           fi
 
-      - name: Run tests and build
-        uses: ./.github/workflows/actions/test-and-build
+      - name: Set release tag output
+        id: set-tag
+        run: echo "release-tag=${RELEASE_TAG}" >> $GITHUB_OUTPUT
+
+      - name: Upload updated package.json
+        uses: actions/upload-artifact@v4
+        with:
+          name: updated-package-json
+          path: package.json
+
+  build-and-package:
+    name: Check, Build and Package
+    runs-on: ubuntu-latest
+    needs: prepare-release
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+
+      - name: Download updated package.json
+        uses: actions/download-artifact@v4
+        with:
+          name: updated-package-json
+
+      - name: Setup Node.js Environment
+        uses: actions/setup-node@v4
+        with:
+          node-version: 22.15.1
+          cache: npm
+
+      - name: Check, build and package
+        uses: ./.github/workflows/actions/build-and-package
         with:
           SEGMENT_KEY: ${{ secrets.SEGMENT_KEY_PROD }}
           ARTIFACTORY_HOST: ${{ secrets.ARTIFACTORY_HOST }}
@@ -97,9 +130,57 @@ jobs:
           SNYK_TOKEN: ${{ secrets.SNYK_TOKEN }}
           JIRA_API_TOKEN: ${{ secrets.JIRA_API_TOKEN }}
 
+  test:
+    name: Test
+    needs: build-and-package
+
+    strategy:
+      matrix:
+        os: [ubuntu-latest, windows-latest, macos-latest]
+      fail-fast: false
+
+    runs-on: ${{ matrix.os }}
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+
+      - name: Download updated package.json
+        uses: actions/download-artifact@v4
+        with:
+          name: updated-package-json
+
+      - name: Setup Node.js Environment
+        uses: actions/setup-node@v4
+        with:
+          node-version: 22.15.1
+          cache: npm
+
+      - name: Run tests
+        uses: ./.github/workflows/actions/run-tests
+        with:
+          SEGMENT_KEY: ${{ secrets.SEGMENT_KEY_PROD }}
+
+  create-draft-release:
+    name: Create Draft Release
+    runs-on: ubuntu-latest
+    needs: [prepare-release, test]
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - name: Download VSIX artifact
+        uses: actions/download-artifact@v4
+        with:
+          name: VSIX Package
+
       - name: Create Draft Release
         run: |
           set -e
+          RELEASE_TAG="${{ needs.prepare-release.outputs.release-tag }}"
           echo Creating draft release for: "${RELEASE_TAG}"
           ls *.vsix
           ls *.vsix.sig
@@ -114,4 +195,3 @@ jobs:
         shell: bash
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-
diff --git a/.github/workflows/test-and-build-from-fork.yaml b/.github/workflows/test-and-build-from-fork.yaml
@@ -8,8 +8,40 @@ permissions:
   pull-requests: write
 
 jobs:
-  test-and-build:
-    name: Test and Build
+  build-and-package:
+    name: Check, Build and Package
+    runs-on: ubuntu-latest
+    if: github.event.pull_request.user.login == 'dependabot[bot]' || github.event.pull_request.head.repo.full_name != github.repository
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+          ref: ${{github.event.pull_request.head.ref}}
+          repository: ${{github.event.pull_request.head.repo.full_name}}
+
+      - name: Setup Node.js Environment
+        uses: actions/setup-node@v4
+        with:
+          node-version: 22.15.1
+          cache: npm
+
+      - name: Check, build and package
+        uses: ./.github/workflows/actions/build-and-package
+        with:
+          SEGMENT_KEY: ${{ secrets.SEGMENT_KEY_DEV }}
+          ARTIFACTORY_HOST: ${{ secrets.ARTIFACTORY_HOST }}
+          ARTIFACTORY_PASSWORD: ${{ secrets.ARTIFACTORY_PASSWORD }}
+          ARTIFACTORY_USERNAME: ${{ secrets.ARTIFACTORY_USERNAME }}
+          GARASIGN_PASSWORD: ${{ secrets.GARASIGN_PASSWORD }}
+          GARASIGN_USERNAME: ${{ secrets.GARASIGN_USERNAME }}
+          SNYK_TOKEN: ${{ secrets.SNYK_TOKEN }}
+          JIRA_API_TOKEN: ${{ secrets.JIRA_API_TOKEN }}
+
+  test:
+    name: Test
+    needs: build-and-package
     if: github.event.pull_request.user.login == 'dependabot[bot]' || github.event.pull_request.head.repo.full_name != github.repository
 
     strategy:
@@ -33,25 +65,16 @@ jobs:
           node-version: 22.15.1
           cache: npm
 
-      - name: Install Dependencies
-        run: npm ci --omit=optional
-
-      - name: Run Checks
-        run: npm run check
-        # the glob here just fails
-        if: ${{ runner.os != 'Windows' }}
-
-      - name: Run Tests
-        env:
-          NODE_OPTIONS: "--max_old_space_size=4096"
+      - name: Run tests
+        uses: ./.github/workflows/actions/run-tests
+        with:
           SEGMENT_KEY: ${{ secrets.SEGMENT_KEY_DEV }}
-        run: npm run test
 
   merge-dependabot-pr:
     name: Merge Dependabot PR
     runs-on: ubuntu-latest
     needs:
-      - test-and-build
+      - test
     if: github.event.pull_request.user.login == 'dependabot[bot]'
     steps:
       - name: Enable auto-merge for Dependabot PRs
diff --git a/.github/workflows/test-and-build.yaml b/.github/workflows/test-and-build.yaml
@@ -14,17 +14,11 @@ permissions:
   contents: read
 
 jobs:
-  test-and-build:
-    name: Test and Build
+  build-and-package:
+    name: Check, Build and Package
+    runs-on: ubuntu-latest
     if: github.event.pull_request.user.login != 'dependabot[bot]' && github.event.pull_request.head.repo.full_name == github.repository
 
-    strategy:
-      matrix:
-        os: [ubuntu-latest, windows-latest, macos-latest]
-      fail-fast: false
-
-    runs-on: ${{ matrix.os }}
-
     steps:
       - name: Checkout
         uses: actions/checkout@v4
@@ -37,8 +31,8 @@ jobs:
           node-version: 22.15.1
           cache: npm
 
-      - name: Run tests and build
-        uses: ./.github/workflows/actions/test-and-build
+      - name: Check, build and package
+        uses: ./.github/workflows/actions/build-and-package
         with:
           SEGMENT_KEY: ${{ secrets.SEGMENT_KEY_PROD }}
           ARTIFACTORY_HOST: ${{ secrets.ARTIFACTORY_HOST }}
@@ -48,3 +42,32 @@ jobs:
           GARASIGN_USERNAME: ${{ secrets.GARASIGN_USERNAME }}
           SNYK_TOKEN: ${{ secrets.SNYK_TOKEN }}
           JIRA_API_TOKEN: ${{ secrets.JIRA_API_TOKEN }}
+
+  test:
+    name: Test
+    needs: build-and-package
+    if: github.event.pull_request.user.login != 'dependabot[bot]' && github.event.pull_request.head.repo.full_name == github.repository
+
+    strategy:
+      matrix:
+        os: [ubuntu-latest, windows-latest, macos-latest]
+      fail-fast: false
+
+    runs-on: ${{ matrix.os }}
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+
+      - name: Setup Node.js Environment
+        uses: actions/setup-node@v4
+        with:
+          node-version: 22.15.1
+          cache: npm
+
+      - name: Run tests
+        uses: ./.github/workflows/actions/run-tests
+        with:
+          SEGMENT_KEY: ${{ secrets.SEGMENT_KEY_PROD }}
