Merge pull request #171 from paritytech/ci/share-codegen-artifact

ci: share codegen output across jobs via artifact

Author: pgherveou

.github/workflows/ci.yml

@@ -64,18 +64,29 @@ jobs:
       - name: Run codegen
         run: ./scripts/codegen.sh
 
+      - name: Upload codegen output
+        uses: actions/upload-artifact@v4
+        with:
+          name: codegen-output
+          if-no-files-found: error
+          retention-days: 1
+          path: |
+            js/packages/truapi/src/generated
+            js/packages/truapi/src/playground/codegen
+            js/packages/truapi/src/explorer/codegen
+            js/packages/truapi/src/explorer/versions.ts
+            js/packages/truapi-host/src/generated
+            playground/test/generated
+
   ts-client:
     name: '@parity/truapi'
     runs-on: ubuntu-latest
+    needs: codegen
+    env:
+      TRUAPI_REQUIRE_GENERATED: 1
     steps:
       - uses: actions/checkout@v4
 
-      - uses: dtolnay/rust-toolchain@nightly
-
-      - uses: dtolnay/rust-toolchain@stable
-
-      - uses: Swatinem/rust-cache@v2
-
       - uses: actions/setup-node@v4
         with:
           node-version: 22
@@ -84,6 +95,11 @@ jobs:
         with:
           bun-version: latest
 
+      - name: Download codegen output
+        uses: actions/download-artifact@v4
+        with:
+          name: codegen-output
+
       - name: Install
         run: npm ci
 
@@ -97,21 +113,22 @@ jobs:
     name: Playground (build + lint)
     runs-on: ubuntu-latest
     needs: ts-client
+    env:
+      TRUAPI_REQUIRE_GENERATED: 1
     steps:
       - uses: actions/checkout@v4
 
-      - uses: dtolnay/rust-toolchain@nightly
-
-      - uses: dtolnay/rust-toolchain@stable
-
-      - uses: Swatinem/rust-cache@v2
-
       - uses: actions/setup-node@v4
         with:
           node-version: 22
 
+      - name: Download codegen output
+        uses: actions/download-artifact@v4
+        with:
+          name: codegen-output
+
       - name: Install workspace deps + build @parity/truapi
-        run: npm ci && ./scripts/codegen.sh
+        run: npm ci
 
       - name: Install playground deps
         working-directory: playground
@@ -137,21 +154,22 @@ jobs:
     name: Explorer (build + lint)
     runs-on: ubuntu-latest
     needs: ts-client
+    env:
+      TRUAPI_REQUIRE_GENERATED: 1
     steps:
       - uses: actions/checkout@v4
 
-      - uses: dtolnay/rust-toolchain@nightly
-
-      - uses: dtolnay/rust-toolchain@stable
-
-      - uses: Swatinem/rust-cache@v2
-
       - uses: actions/setup-node@v4
         with:
           node-version: 22
 
+      - name: Download codegen output
+        uses: actions/download-artifact@v4
+        with:
+          name: codegen-output
+
       - name: Install workspace deps + build @parity/truapi
-        run: npm ci && ./scripts/codegen.sh
+        run: npm ci
 
       - name: Install explorer deps
         working-directory: explorer
@@ -172,17 +190,13 @@ jobs:
     runs-on: ubuntu-latest
     needs: playground
     timeout-minutes: 30
+    env:
+      TRUAPI_REQUIRE_GENERATED: 1
     steps:
       - uses: actions/checkout@v4
         with:
           submodules: recursive
 
-      - uses: dtolnay/rust-toolchain@nightly
-
-      - uses: dtolnay/rust-toolchain@stable
-
-      - uses: Swatinem/rust-cache@v2
-
       - uses: actions/setup-node@v4
         with:
           node-version: 22
@@ -191,8 +205,13 @@ jobs:
         with:
           bun-version: latest
 
+      - name: Download codegen output
+        uses: actions/download-artifact@v4
+        with:
+          name: codegen-output
+
       - name: Build @parity/truapi
-        run: npm ci && ./scripts/codegen.sh
+        run: npm ci
 
       - name: Install dotli deps
         working-directory: hosts/dotli

js/packages/truapi-host/scripts/ensure-generated.sh

@@ -22,4 +22,11 @@ if [ "$missing" -eq 0 ]; then
   exit 0
 fi
 
+if [ "${TRUAPI_REQUIRE_GENERATED:-0}" = "1" ]; then
+  echo "ensure-generated: generated files are missing and TRUAPI_REQUIRE_GENERATED=1, so codegen will not run." >&2
+  echo "These files are expected to be restored from the 'codegen-output' CI artifact." >&2
+  echo "If you added a generated output, add its path to the upload-artifact step in .github/workflows/ci.yml." >&2
+  exit 1
+fi
+
 TRUAPI_SKIP_PACKAGE_BUILD=1 ./scripts/codegen.sh

js/packages/truapi/scripts/ensure-generated.sh

@@ -26,4 +26,11 @@ if [ "$missing" -eq 0 ] && find playground/test/generated/examples -name '*.ts'
   exit 0
 fi
 
+if [ "${TRUAPI_REQUIRE_GENERATED:-0}" = "1" ]; then
+  echo "ensure-generated: generated files are missing and TRUAPI_REQUIRE_GENERATED=1, so codegen will not run." >&2
+  echo "These files are expected to be restored from the 'codegen-output' CI artifact." >&2
+  echo "If you added a generated output, add its path to the upload-artifact step in .github/workflows/ci.yml." >&2
+  exit 1
+fi
+
 TRUAPI_SKIP_PACKAGE_BUILD=1 ./scripts/codegen.sh