Merge pull request #496 from scratchfoundation/version-before-build

fix(ci): build with new version before testing and publishing

Author: cwillisf

.github/workflows/ci.yml

@@ -34,7 +34,7 @@ jobs:
         with:
           cache: 'npm'
           node-version-file: '.nvmrc'
-      - name: Debug info
+      - name: Debug Info
         # https://docs.github.com/en/actions/reference/security/secure-use#use-an-intermediate-environment-variable
         env:
           # `env:` values are printed to the log even without using them in `run:`
@@ -54,7 +54,7 @@ jobs:
         with:
           filters: ./.github/path-filters.yml
 
-      - name: Resolve changed packages
+      - name: Resolve Changed Packages
         id: filter
         run: |
           if [ "${{ inputs.force-full-build }}" = "true" ]; then
@@ -70,14 +70,12 @@ jobs:
       - if: ${{ steps.filter.outputs.any-workspace == 'true' }}
         uses: ./.github/actions/install-dependencies
 
-      # IMPORTANT: always build all packages or none - never a subset.
-      # The publish workflow reuses these artifacts, so partial artifacts would cause publish
-      # failures for omitted packages.
-      - name: Build packages
+      # TODO: Packages currently depend on each other's compiled dist at build time. Fix that and matrix the builds.
+      - name: Build Packages
         if: ${{ steps.filter.outputs.any-workspace == 'true' }}
         run: npm run build
 
-      - name: Store build artifacts
+      - name: Store Build Artifacts
         if: ${{ steps.filter.outputs.any-workspace == 'true' }}
         uses: actions/upload-artifact@330a01c490aca151604b8cf639adc76d48f6c5d4 # v5
         with:
@@ -89,36 +87,15 @@ jobs:
             packages/**/playground
 
   test:
-    runs-on: ubuntu-latest
+    name: Test
     needs: build
     if: ${{ needs.build.outputs.any-workspace == 'true' && needs.build.outputs.packages != '[]' }}
-    permissions:
-      checks: write
-      pull-requests: write
-      contents: read
-      issues: read
-    strategy:
-      fail-fast: false
-      matrix:
-        package: ${{ fromJSON(needs.build.outputs.packages) }}
-    name: Test ${{ matrix.package }}
-    steps:
-      - uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # v5
-      - uses: actions/setup-node@2028fbc5c25fe9cf00d9f06a71cc4710d4507903 # v6
-        with:
-          cache: 'npm'
-          node-version-file: '.nvmrc'
-      - uses: ./.github/actions/install-dependencies
-      - uses: actions/download-artifact@018cc2cf5baa6db3ef3c5f8a56943fffe632ef53 # v6
-        with:
-          name: build
-          path: packages
-      - uses: ./.github/actions/test-package
-        with:
-          package_name: ${{ matrix.package }}
+    uses: ./.github/workflows/test-packages.yml
+    with:
+      packages: ${{ needs.build.outputs.packages }}
 
   preview:
-    runs-on: ubuntu-latest
+    name: Preview
     needs: build
     # We don't want to give forks free reign to publish to our GitHub Pages, so run this job only if both:
     # - any workspace changed (otherwise there's no work to do)
@@ -135,68 +112,9 @@ jobs:
         ) &&
         (!startsWith((github.head_ref || github.ref_name), 'renovate/'))
       }}
-    name: Publish preview playgrounds to GitHub Pages
-    steps:
-      - uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # v5
-        with:
-          sparse-checkout: .github/actions/deploy-pages-with-retry/
-          fetch-depth: 1
-          sparse-checkout-cone-mode: true
-          persist-credentials: false
-          lfs: false
-          submodules: false
-      - name: Determine GitHub Pages directory name
-        id: branch_dir_name
-        # even `develop` should be published to a subdirectory
-        # that way each branch can be updated or cleaned up independently
-        run: |
-          echo "result=${GITHUB_REF_NAME//[^A-Za-z0-9._-]/_}" | tee --append "$GITHUB_OUTPUT"
-      - uses: actions/download-artifact@018cc2cf5baa6db3ef3c5f8a56943fffe632ef53 # v6
-        with:
-          name: build
-          path: packages
-      - name: Prepare playgrounds for GitHub Pages
-        working-directory: ./packages
-        run: |
-          mkdir -p ../pages/
-          for pkg in *; do
-            if [ -d "${pkg}/playground" ]; then
-              # using symlinks is quick and artifact generation will dereference them
-              # if the GitHub Pages action stops dereferencing these links, we'll need to copy the files instead
-              ln -s "../packages/${pkg}/playground" "../pages/${pkg}"
-            fi
-          done
-
-          # scratch-gui doesn't follow the pattern above
-          ln -s "../packages/scratch-gui/build" "../pages/scratch-gui"
-
-          ls -l ../pages/
-      - name: Deploy playgrounds to GitHub Pages
-        uses: ./.github/actions/deploy-pages-with-retry
-        with:
-          github_token: ${{ secrets.GITHUB_TOKEN }}
-          publish_dir: ./pages
-          destination_dir: "${{steps.branch_dir_name.outputs.result}}"
-          full_commit_message: "Build for ${{ github.sha }} ${{ github.event.head_commit.message }}"
-
-  results:
-    name: Test Results
-    runs-on: ubuntu-latest
-    needs: test
-    if: ${{ !cancelled() && needs.test.result != 'skipped' }}
-    steps:
-      - run: |
-          case "${{ needs.test.result }}" in
-            success)
-              echo "Tests passed successfully."
-              exit 0
-              ;;
-            cancelled)
-              echo "Tests were cancelled."
-              exit 1
-              ;;
-            *)
-              echo "Tests failed. Result: ${{ needs.test.result }}"
-              exit 1
-              ;;
-          esac
+    uses: ./.github/workflows/deploy-playground-preview.yml
+    with:
+      # even `develop` should be published to a subdirectory
+      # that way each branch can be updated or cleaned up independently
+      destination_dir: ${{ github.head_ref || github.ref_name }}
+      full_commit_message: "Build for ${{ github.sha }} ${{ github.event.head_commit.message }}"

.github/workflows/commitlint.yml

@@ -1,4 +1,4 @@
-name: Lint commit messages
+name: Lint Commit Messages
 on: [pull_request]
 
 concurrency:

.github/workflows/deploy-playground-preview.yml

@@ -0,0 +1,60 @@
+name: Deploy Playground Preview
+
+on:
+  workflow_call:
+    inputs:
+      destination_dir:
+        description: 'Destination subdirectory for GitHub Pages (will be sanitized)'
+        type: string
+        required: true
+      full_commit_message:
+        description: 'Commit message for the GitHub Pages deployment'
+        type: string
+        required: true
+
+jobs:
+  preview:
+    runs-on: ubuntu-latest
+    name: Publish Preview Playgrounds to GitHub Pages
+    steps:
+      - uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # v5
+        with:
+          sparse-checkout: .github/actions/deploy-pages-with-retry/
+          fetch-depth: 1
+          sparse-checkout-cone-mode: true
+          persist-credentials: false
+          lfs: false
+          submodules: false
+      - name: Sanitize Destination Directory Name
+        id: dir
+        env:
+          DESTINATION_DIR: ${{ inputs.destination_dir }}
+        run: |
+          echo "result=${DESTINATION_DIR//[^A-Za-z0-9._-]/_}" | tee --append "$GITHUB_OUTPUT"
+      - uses: actions/download-artifact@018cc2cf5baa6db3ef3c5f8a56943fffe632ef53 # v6
+        with:
+          name: build
+          path: packages
+      - name: Prepare Playgrounds for GitHub Pages
+        working-directory: ./packages
+        run: |
+          mkdir -p ../pages/
+          for pkg in *; do
+            if [ -d "${pkg}/playground" ]; then
+              # using symlinks is quick and artifact generation will dereference them
+              # if the GitHub Pages action stops dereferencing these links, we'll need to copy the files instead
+              ln -s "../packages/${pkg}/playground" "../pages/${pkg}"
+            fi
+          done
+
+          # scratch-gui doesn't follow the pattern above
+          ln -s "../packages/scratch-gui/build" "../pages/scratch-gui"
+
+          ls -l ../pages/
+      - name: Deploy Playgrounds to GitHub Pages
+        uses: ./.github/actions/deploy-pages-with-retry
+        with:
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+          publish_dir: ./pages
+          destination_dir: "${{ steps.dir.outputs.result }}"
+          full_commit_message: "${{ inputs.full_commit_message }}"

.github/workflows/gha-debug.yml

@@ -1,4 +1,4 @@
-name: GitHub Actions debug info
+name: GitHub Actions Debug Info
 
 on:
   branch_protection_rule:
@@ -41,7 +41,7 @@ jobs:
   info:
     runs-on: ubuntu-latest
     steps:
-      - name: Output debug info
+      - name: Output Debug Info
         env:
           github: ${{ toJson(github) }}
         run: |

.github/workflows/ghpages-cleanup.yml

@@ -15,16 +15,16 @@ jobs:
       contents: write
     runs-on: ubuntu-latest
     steps:
-      - name: Check out GitHub Pages branch
+      - name: Check Out GitHub Pages Branch
         uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # v5
         with:
           # replace `fetch-depth` with `shallow-since` if and when actions/checkout#619 (or an equivalent) gets merged
           # then remove the "Fetch a bit more history" step below
           fetch-depth: 1
           ref: gh-pages
-      - name: Fetch a bit more history
+      - name: Fetch a Bit More History
         run: git fetch --update-shallow --shallow-since="32 days ago" origin gh-pages
-      - name: Mark stale directories for removal
+      - name: Mark Stale Directories for Removal
         run: |
           for dir in */; do
             [ -L "${dir%/}" ] && continue  # skip symlinks (trim trailing slash for test)
@@ -33,7 +33,7 @@ jobs:
               git rm --quiet -r "$dir"
             fi
           done
-      - name: Configure git user
+      - name: Configure Git User
         run: |
           git config user.name 'github-actions[bot]'
           git config user.email 'github-actions[bot]@users.noreply.github.com'