test: push nitro contracts docker image to ghcr

Author: alxdca

.github/workflows/build-test.yml

@@ -226,24 +226,32 @@ jobs:
   test-integration-anvil:
     name: Test (Integration Anvil)
     runs-on: ubuntu-latest
-    env:
-      NITRO_CONTRACTS_IMAGE_REF: v3.2.0-2f747c7
+    permissions:
+      contents: read
+      packages: read
     steps:
       - name: Checkout
         uses: actions/checkout@v4
 
-      - name: Set up Docker Buildx
-        uses: docker/setup-buildx-action@v3
+      - name: Set nitro contracts image
+        run: |
+          echo "NITRO_CONTRACTS_GHCR_IMAGE=ghcr.io/${GITHUB_REPOSITORY_OWNER,,}/chain-sdk-nitro-contracts:v3.2.0-2f747c7" >> "$GITHUB_ENV"
 
-      - name: Build nitro contracts image
-        uses: docker/build-push-action@v6
+      - name: Log in to GHCR
+        uses: docker/login-action@v3
         with:
-          context: ./nitro-contracts
-          file: ./nitro-contracts/Dockerfile
-          tags: chain-sdk-nitro-contracts:${{ env.NITRO_CONTRACTS_IMAGE_REF }}
-          load: true
-          cache-from: type=gha,scope=chain-sdk-nitro-contracts-${{ env.NITRO_CONTRACTS_IMAGE_REF }}
-          cache-to: type=gha,mode=max,scope=chain-sdk-nitro-contracts-${{ env.NITRO_CONTRACTS_IMAGE_REF }}
+          registry: ghcr.io
+          username: ${{ github.actor }}
+          password: ${{ secrets.GITHUB_TOKEN }}
+
+      - name: Load nitro contracts image
+        run: |
+          if ! docker pull "${NITRO_CONTRACTS_GHCR_IMAGE}"; then
+            docker build \
+              -f ./nitro-contracts/Dockerfile \
+              -t "${NITRO_CONTRACTS_GHCR_IMAGE}" \
+              ./nitro-contracts
+          fi
 
       - name: Setup pnpm
         uses: pnpm/action-setup@v4
@@ -288,3 +296,36 @@ jobs:
         with:
           path: .cache/anvil-rpc-cache.json
           key: ${{ runner.os }}-anvil-rpc-cache-${{ github.ref_name }}-${{ github.run_id }}
+
+  publish-nitro-contracts-image:
+    name: Publish Nitro Contracts Image
+    runs-on: ubuntu-latest
+    permissions:
+      contents: read
+      packages: write
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - name: Set nitro contracts image
+        run: |
+          echo "NITRO_CONTRACTS_GHCR_IMAGE=ghcr.io/${GITHUB_REPOSITORY_OWNER,,}/chain-sdk-nitro-contracts:v3.2.0-2f747c7"
+
+      - name: Set up Docker Buildx
+        uses: docker/setup-buildx-action@v3
+
+      - name: Log in to GHCR
+        uses: docker/login-action@v3
+        with:
+          registry: ghcr.io
+          username: ${{ github.actor }}
+          password: ${{ secrets.GITHUB_TOKEN }}
+
+      - name: Build and push nitro contracts image
+        uses: docker/build-push-action@v6
+        with:
+          context: ./nitro-contracts
+          file: ./nitro-contracts/Dockerfile
+          push: true
+          tags: |
+            ${{ env.NITRO_CONTRACTS_GHCR_IMAGE }}

src/integrationTestHelpers/constants.ts

@@ -4,7 +4,7 @@ import { ethers } from 'ethers';
 export const testConstants = {
   DEFAULT_ANVIL_IMAGE: 'ghcr.io/foundry-rs/foundry:v1.3.1',
   DEFAULT_NITRO_IMAGE: 'offchainlabs/nitro-node:v3.9.5-66e42c4',
-  DEFAULT_NITRO_CONTRACTS_REF: 'v3.2.0-2f747c7',
+  DEFAULT_NITRO_CONTRACTS_IMAGE: 'ghcr.io/offchainlabs/chain-sdk-nitro-contracts:v3.2.0-2f747c7',
   DEFAULT_L2_CHAIN_ID: 421_337,
   DEFAULT_L3_CHAIN_ID: 421_338,
   DEFAULT_L1_RPC_PORT: 9645,

src/integrationTestHelpers/dockerHelpers.ts

@@ -36,24 +36,18 @@ export function dockerAsync(args: string[]): Promise<string> {
   });
 }
 
-function sanitizeDockerTagPart(value: string): string {
-  return value.replace(/[^a-zA-Z0-9_.-]+/g, '-');
-}
-
 export function getNitroContractsImage(): string {
-  const imageTag = `chain-sdk-nitro-contracts:${sanitizeDockerTagPart(
-    testConstants.DEFAULT_NITRO_CONTRACTS_REF,
-  )}`;
-
+  const image = process.env.NITRO_CONTRACTS_GHCR_IMAGE ?? testConstants.DEFAULT_NITRO_CONTRACTS_IMAGE;
   try {
-    docker(['image', 'inspect', imageTag]);
+    docker(['image', 'inspect', image]);
+    return image;
   } catch {
     const nitroContractsDir = join(process.cwd(), 'nitro-contracts');
     const dockerfilePath = join(process.cwd(), 'nitro-contracts', 'Dockerfile');
-    docker(['build', '-f', dockerfilePath, '-t', imageTag, nitroContractsDir]);
-  }
+    docker(['build', '-f', dockerfilePath, '-t', image, nitroContractsDir]);
 
-  return imageTag;
+    return image;
+  }
 }
 
 export function createDockerNetwork(networkName: string) {