From ea9351a1045c383394fc9c00293b3c0774a4c4e1 Mon Sep 17 00:00:00 2001
From: Patrik Oldsberg <poldsberg@gmail.com>
Date: Sun, 3 Jul 2022 20:55:35 +0200
Subject: [PATCH] workflows/ci: split tests into separate job

Signed-off-by: Patrik Oldsberg <poldsberg@gmail.com>
---
 .github/workflows/ci.yml | 146 ++++++++++++++++++++++++++++-----------
 1 file changed, 107 insertions(+), 39 deletions(-)

diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
index 95ec35c795..a51daa2136 100644
--- a/.github/workflows/ci.yml
+++ b/.github/workflows/ci.yml
@@ -9,9 +9,116 @@ concurrency:
   cancel-in-progress: true
 
 jobs:
+  # This step only runs yarn install to make sure that an exact match is available
+  # in the cache. The two following verify and tests jobs then always install from cache.
+  install:
+    runs-on: ubuntu-latest
+
+    strategy:
+      matrix:
+        node-version: [14.x, 16.x]
+
+    env:
+      CI: true
+      NODE_OPTIONS: --max-old-space-size=4096
+
+    steps:
+      - uses: actions/checkout@v3
+
+      - name: use node.js ${{ matrix.node-version }}
+        uses: actions/setup-node@v3
+        with:
+          node-version: ${{ matrix.node-version }}
+          registry-url: https://registry.npmjs.org/ # Needed for auth
+
+      - name: yarn install
+        uses: backstage/actions/yarn-install@v0.2.2
+        with:
+          cache-prefix: ${{ runner.os }}-v${{ matrix.node-version }}
+
+  # The verify jobs runs all the verification that doesn't require a
+  # diff towards master, since it takes some time to fetch that.
   verify:
     runs-on: ubuntu-latest
 
+    needs: install
+
+    strategy:
+      matrix:
+        node-version: [14.x, 16.x]
+
+    env:
+      CI: true
+      NODE_OPTIONS: --max-old-space-size=4096
+
+    steps:
+      - uses: actions/checkout@v3
+
+      - name: use node.js ${{ matrix.node-version }}
+        uses: actions/setup-node@v3
+        with:
+          node-version: ${{ matrix.node-version }}
+          registry-url: https://registry.npmjs.org/ # Needed for auth
+
+      - name: yarn install
+        uses: backstage/actions/yarn-install@v0.2.2
+        with:
+          cache-prefix: ${{ runner.os }}-v${{ matrix.node-version }}
+
+      - name: verify changesets
+        run: node scripts/verify-changesets.js
+
+      - name: verify local dependency ranges
+        run: node scripts/verify-local-dependencies.js
+
+      - name: validate config
+        run: yarn backstage-cli config:check --lax
+
+      - name: type checking and declarations
+        run: yarn tsc:full
+
+      - name: prettier
+        run: yarn prettier:check
+
+        # We need to generate the API references as well, so that we can verify the doc links
+      - name: check api reports and generate API reference
+        run: yarn build:api-reports:only --ci --docs
+
+      - name: verify api reference
+        run: node scripts/verify-api-reference.js
+
+      - name: verify doc links
+        run: node scripts/verify-links.js
+
+      - name: build all packages
+        run: yarn backstage-cli repo build --all
+
+      - name: verify type dependencies
+        run: yarn lint:type-deps
+
+      - name: verify plugin template
+        run: yarn lerna -- run diff -- --check
+
+      - name: ensure clean working directory
+        run: |
+          if files=$(git ls-files --exclude-standard --others --modified) && [[ -z "$files" ]]; then
+            exit 0
+          else
+            echo ""
+            echo "Working directory has been modified:"
+            echo ""
+            git status --short
+            echo ""
+            exit 1
+          fi
+
+  # The test job runs all tests as well as any verification step that
+  # requires a diff towards master.
+  test:
+    runs-on: ubuntu-latest
+
+    needs: install
+
     strategy:
       matrix:
         node-version: [14.x, 16.x]
@@ -80,48 +187,12 @@ jobs:
         run: git diff --quiet origin/master HEAD -- yarn.lock
         continue-on-error: true
 
-      - name: prettier
-        run: yarn prettier:check
-
       - name: lock
         run: yarn lock:check
 
-      - name: validate config
-        run: yarn backstage-cli config:check --lax
-
       - name: lint
         run: yarn backstage-cli repo lint --since origin/master
 
-      - name: type checking and declarations
-        run: yarn tsc:full
-
-        # We need to generate the API references as well, so that we can verify the doc links
-      - name: check api reports and generate API reference
-        run: yarn build:api-reports:only --ci --docs
-
-      - name: verify api reference
-        run: node scripts/verify-api-reference.js
-
-      - name: verify changesets
-        run: node scripts/verify-changesets.js
-
-      - name: verify doc links
-        run: node scripts/verify-links.js
-
-      - name: verify local dependency ranges
-        run: node scripts/verify-local-dependencies.js
-
-      - name: build changed packages
-        if: ${{ steps.yarn-lock.outcome == 'success' }}
-        run: yarn backstage-cli repo build --all --since origin/master
-
-      - name: build all packages
-        if: ${{ steps.yarn-lock.outcome == 'failure' }}
-        run: yarn backstage-cli repo build --all
-
-      - name: verify type dependencies
-        run: yarn lint:type-deps
-
       - name: test changed packages
         if: ${{ steps.yarn-lock.outcome == 'success' }}
         run: yarn lerna -- run test --since origin/master -- --coverage --runInBand
@@ -144,9 +215,6 @@ jobs:
           BACKSTAGE_TEST_DATABASE_POSTGRES9_CONNECTION_STRING: postgresql://postgres:postgres@localhost:${{ job.services.postgres9.ports[5432] }}
           BACKSTAGE_TEST_DATABASE_MYSQL8_CONNECTION_STRING: mysql://root:root@localhost:${{ job.services.mysql8.ports[3306] }}/ignored
 
-      - name: verify plugin template
-        run: yarn lerna -- run diff -- --check
-
       - name: ensure clean working directory
         run: |
           if files=$(git ls-files --exclude-standard --others --modified) && [[ -z "$files" ]]; then