Add CI Job to check generate file changes

.github/workflows/checks.yml

@@ -26,8 +26,72 @@ jobs:
       - name: Lint
         run: npm run check
 
+  generate:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+      - name: Restore Cargo cache
+        id: cargo-cache
+        uses: actions/cache/restore@v4
+        with:
+          path: |
+            ~/.cargo/bin/
+            ~/.cargo/registry/index/
+            ~/.cargo/registry/cache/
+            ~/.cargo/git/db/
+            target/
+          key: ${{ runner.os }}-cargo-${{ hashFiles('**/Cargo.lock') }}
+      - name: Add Rust
+        uses: dtolnay/rust-toolchain@stable
+        with:
+          toolchain: stable
+          targets: wasm32-unknown-unknown
+      - name: Install dependencies
+        run: npm ci
+      - name: Set env
+        run: |
+          release=$(curl --silent "https://api.github.com/repos/dfinity/candid/releases/latest" | grep -e '"tag_name"' | cut -c 16-25)
+          echo "DIDC_RELEASE=$(echo $release)" >> $GITHUB_ENV
+      - name: Restore didc cache
+        id: didc-cache
+        uses: actions/cache/restore@v4
+        with:
+          path: /usr/local/bin/didc
+          key: ${{ runner.os }}-didc-${{ env.DIDC_RELEASE }}
+      - name: Add didc dependency
+        if: steps.didc-cache.outputs.cache-hit != 'true'
+        run: |
+          curl -SL https://github.com/dfinity/candid/releases/download/$DIDC_RELEASE/didc-linux64 > /usr/local/bin/didc
+          chmod +x /usr/local/bin/didc
+      - name: Save didc
+        uses: actions/cache/save@v4
+        if: steps.didc-cache.outputs.cache-hit != 'true'
+        with: 
+          path: /usr/local/bin/didc
+          key: ${{ runner.os }}-didc-${{ env.DIDC_RELEASE }}
+      - name: Install candid-extractor
+        if: steps.cargo-cache.outputs.cache-hit != 'true'
+        run: cargo install candid-extractor
+      - name: Generating candids
+        run: ENV=github npm run generate
+      - name: Save Cargo
+        uses: actions/cache/save@v4
+        if: steps.cargo-cache.outputs.cache-hit != 'true'
+        with:
+          path: |
+            ~/.cargo/bin/
+            ~/.cargo/registry/index/
+            ~/.cargo/registry/cache/
+            ~/.cargo/git/db/
+            target/
+          key: ${{ runner.os }}-cargo-${{ hashFiles('**/Cargo.lock') }}
+      - name: Check if files are touched
+        run: if [[ -n $(git status --porcelain) ]]; then echo "Files diff. Failed. Exiting" >&2 && exit 1; else echo "PASSED"; fi
+
   may-merge:
-    needs: ['check', 'lint']
+    needs: ['check', 'lint', 'generate']
     runs-on: ubuntu-latest
     steps:
       - name: Cleared for merging

HACKING.md

@@ -7,6 +7,7 @@ This document explains how to run locally [Juno](https://juno.build).
 - [Run locally](#run-locally)
 - [Development](#development)
 - [Top-up](#top-up)
+- [Troubleshooting](#troubleshooting)
 
 ## Run locally
 
@@ -76,3 +77,23 @@ Top-up the local console with some cycles:
 ```
 npm run console:topup
 ```
+
+## Troubleshooting
+
+### didc command not found
+
+Go to [Candid releases](https://github.com/dfinity/candid/releases) page to download your OS version didc.
+
+Example, for macos
+
+```sh
+release=$(curl --silent "https://api.github.com/repos/dfinity/candid/releases/latest" | grep -e '"tag_name"' | cut -c 16-25)
+curl -fsSL https://github.com/dfinity/candid/releases/download/$release/didc-macos > ~/.cargo/bin/didc
+chmod 755 ~/.cargo/bin/didc
+```
+
+### candid-extractor command not found
+
+```sh
+cargo install candid-extractor
+```

scripts/did.idl.sh

@@ -1,3 +1,5 @@
+#!/usr/bin/env bash
+
 function generate_did_idl() {
   local canister=$1
   local canister_root=$2
@@ -20,6 +22,10 @@ done
 
 generate_did_idl "cmc" "candid"
 generate_did_idl "ic" "candid"
-generate_did_idl "index" "."
-generate_did_idl "ledger" "."
-generate_did_idl "internet_identity" "."
+
+if [ "$ENV" != "github" ]
+then 
+  generate_did_idl "index" "."
+  generate_did_idl "ledger" "."
+  generate_did_idl "internet_identity" "."
+fi