feat: add deploy key and network name to subgraph deployment configuration

Author: Le-Caignec

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

@@ -27,6 +27,8 @@ jobs:
     environment: ${{ github.event.inputs.network }}
     steps:
       - uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
       - uses: actions/setup-node@v4
         with:
           node-version: '20'
@@ -41,5 +43,5 @@ jobs:
           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
+          VERSION_LABEL: ${{ github.event.inputs.version-label }}
+        run: npm run deploy-chainX

.github/workflows/deploy-subgraph.yml

@@ -28,9 +28,13 @@ jobs:
     environment: ${{ github.event.inputs.environment }}
     steps:
       - uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
       - uses: actions/setup-node@v4
         with:
           node-version: '20'
+          cache: 'npm'
+          cache-dependency-path: 'packages/subgraph'
 
       - name: Install dependencies
         working-directory: packages/subgraph

packages/subgraph/.env.template

@@ -15,3 +15,9 @@ START_BLOCK=...
 
 # The slug for the subgraph created on The Graph Network
 SUBGRAPH_SLUG=...
+
+# The deploy key for The Graph Network deployment
+SUBGRAPH_DEPLOY_KEY=...
+
+# The network name for The Graph Network deployment (e.g., arbitrum-sepolia, arbitrum)
+SUBGRAPH_NETWORK_NAME=...

packages/subgraph/config/env.ts

@@ -31,6 +31,16 @@ const envSchema = z.object({
     .string()
     .min(1, 'SUBGRAPH_SLUG must not be empty')
     .optional(),
+
+  SUBGRAPH_DEPLOY_KEY: z
+    .string()
+    .min(1, 'SUBGRAPH_DEPLOY_KEY must not be empty')
+    .optional(),
+
+  SUBGRAPH_NETWORK_NAME: z
+    .string()
+    .min(1, 'SUBGRAPH_NETWORK_NAME 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-chainX": "dotenv -e .env -- sh -c 'graph deploy ${SUBGRAPH_SLUG} subgraph.template.yaml'",
+    "deploy-chainX": "dotenv -e .env -- sh -c 'graph deploy ${SUBGRAPH_SLUG} subgraph.template.yaml --deploy-key ${SUBGRAPH_DEPLOY_KEY} --network ${SUBGRAPH_NETWORK_NAME} --version-label ${VERSION_LABEL}'",
     "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",