feat: enhance subgraph deployment workflow with version label and slug inputs

Author: Le-Caignec

.github/workflows/deploy-subgraph-chainX.yml

@@ -1,15 +1,20 @@
 name: Deploy Subgraph - on TheGraph Network
 
 on:
+  push:
   workflow_dispatch: # Manual trigger
     inputs:
       network:
         description: 'Network'
         required: true
         type: choice
         options:
-          - arbitrum-sepolia
-          - arbitrum-one
+          - arbitrumSepolia
+          - arbitrum
+      version-label:
+        description: 'Version label for the subgraph deployment'
+        required: true
+        type: string
 
 jobs:
   build-and-test:
@@ -20,7 +25,7 @@ jobs:
     needs: build-and-test
     runs-on: ubuntu-latest
     # Associate the job with a GitHub Environment which has pre-defined variables and secrets.
-    environment: ${{ github.event.inputs.environment }}
+    environment: ${{ github.event.inputs.network }}
     steps:
       - uses: actions/checkout@v4
       - uses: actions/setup-node@v4
@@ -31,31 +36,11 @@ jobs:
         working-directory: packages/subgraph
         run: npm ci
 
-      - name: Set Version Label
-        working-directory: packages/subgraph
-        id: set_version
-        run: |
-          if [[ "${{ github.event.inputs.environment }}" == "staging" ]]; then
-            echo "version=${GITHUB_SHA}" >> $GITHUB_OUTPUT
-          else
-            version=$(npm pkg get version | sed 's/"//g')
-            echo "version=$version" >> $GITHUB_OUTPUT
-          fi
-
       - name: Deploy Subgraph
         working-directory: packages/subgraph
         env:
-          NETWORK_NAME: bellecour
-          VERSION_LABEL: ${{ steps.set_version.outputs.version }}
-          GRAPHNODE_URL: ${{ vars.GRAPHNODE_URL }}
-          IPFS_URL: ${{ vars.IPFS_URL }}
-          DEPLOY_ENV: ${{ vars.ENV_NAME }}
-        run: |
-          echo "Starting deployment with the following parameters:"
-          echo "  Network Name: $NETWORK_NAME"
-          echo "  Version Label: $VERSION_LABEL"
-          echo "  DEPLOY_ENV: $DEPLOY_ENV"
-          echo "  GRAPHNODE_URL: $GRAPHNODE_URL"
-          echo "  IPFS_URL: $IPFS_URL"
-          npm run all
-        shell: bash
+          SUBGRAPH_DEPLOY_KEY: ${{ secrets.SUBGRAPH_DEPLOY_KEY }}
+          SUBGRAPH_NETWORK_NAME: ${{ vars.SUBGRAPH_NETWORK_NAME }}
+          SUBGRAPH_SLUG: ${{ vars.SUBGRAPH_SLUG }}
+          VERSION_LABEL: ${{ github.event.inputs.version-label }}
+        run: npm run deploy-chainX -- --deploy-key $SUBGRAPH_DEPLOY_KEY --network $SUBGRAPH_NETWORK_NAME --version-label $VERSION_LABEL

packages/subgraph/.env.template

@@ -12,3 +12,6 @@ VERSION_LABEL=...
 
 # Start block number for local testing
 START_BLOCK=...
+
+# The slug for the subgraph created on The Graph Network
+SUBGRAPH_SLUG=...

packages/subgraph/config/env.ts

@@ -2,24 +2,35 @@ import 'dotenv/config';
 import { z } from 'zod';
 
 const envSchema = z.object({
-    NETWORK_NAME: z.string().min(1, 'NETWORK_NAME is required').default('bellecour'),
+  NETWORK_NAME: z
+    .string()
+    .min(1, 'NETWORK_NAME is required')
+    .default('bellecour'),
 
-    GRAPHNODE_URL: z
-        .string()
-        .url('GRAPHNODE_URL must be a valid URL')
-        .default('http://localhost:8020'),
+  GRAPHNODE_URL: z
+    .string()
+    .url('GRAPHNODE_URL must be a valid URL')
+    .default('http://localhost:8020'),
 
-    IPFS_URL: z.string().url('IPFS_URL must be a valid URL').default('http://localhost:5001'),
+  IPFS_URL: z
+    .string()
+    .url('IPFS_URL must be a valid URL')
+    .default('http://localhost:5001'),
 
-    VERSION_LABEL: z.string().min(1, 'VERSION_LABEL is required').default('bellecour/poco-v5'),
+  VERSION_LABEL: z.string().min(1, 'VERSION_LABEL is required').default('dev'),
 
-    START_BLOCK: z
-        .string()
-        .transform((val) => parseInt(val, 10))
-        .refine((val) => !isNaN(val) && val >= 0, {
-            message: 'START_BLOCK must be a valid non-negative integer',
-        })
-        .or(z.undefined()),
+  START_BLOCK: z
+    .string()
+    .transform((val) => parseInt(val, 10))
+    .refine((val) => !isNaN(val) && val >= 0, {
+      message: 'START_BLOCK must be a valid non-negative integer',
+    })
+    .or(z.undefined()),
+
+  SUBGRAPH_SLUG: z
+    .string()
+    .min(1, 'SUBGRAPH_SLUG must not be empty')
+    .optional(),
 });
 
 export const env = envSchema.parse(process.env);

packages/subgraph/package.json

@@ -5,7 +5,7 @@
   "scripts": {
     "codegen": "graph codegen subgraph.template.yaml",
     "build": "dotenv -e .env -- sh -c 'graph codegen subgraph.template.yaml && graph build subgraph.template.yaml --network ${NETWORK_NAME:-bellecour}'",
-    "deploy-theGraph": "graph deploy --node https://api.thegraph.com/deploy/ DataProtector",
+    "deploy-chainX": "dotenv -e .env -- sh -c 'graph deploy ${SUBGRAPH_SLUG} subgraph.template.yaml'",
     "create": "dotenv -e .env -- sh -c 'graph create --node ${GRAPHNODE_URL:-http://localhost:8020} ${NETWORK_NAME:-bellecour}${DEPLOY_ENV:-/}dataprotector-v2'",
     "deploy": "dotenv -e .env -- sh -c 'graph deploy ${NETWORK_NAME:-bellecour}${DEPLOY_ENV:-/}dataprotector-v2 subgraph.template.yaml --node ${GRAPHNODE_URL:-http://localhost:8020} --ipfs ${IPFS_URL:-http://localhost:5001} --network ${NETWORK_NAME:-bellecour} --version-label ${VERSION_LABEL:-dev}'",
     "clean": "rm -rf generated && rm -rf build",