chore: validate examples workflow (#268)

Author: viviveevee

.github/workflows/validate-examples.yml

@@ -0,0 +1,57 @@
+name: Validate Examples
+
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+
+env:
+  # When getting Rust dependencies, retry on network error:
+  CARGO_NET_RETRY: 10
+  # Use the local .curlrc
+  CURL_HOME: .
+
+jobs:
+  validate-examples:
+    name: Validate Examples on ${{ matrix.os }}
+    runs-on: ${{ matrix.os }}
+
+    strategy:
+      fail-fast: false
+      matrix:
+        os: [ubuntu-latest]
+
+    steps:
+      - uses: actions/checkout@08eba0b27e820071cde6df949e0beb9ba4906955 # v4.3.0
+
+      - name: Setup image (Linux)
+        if: ${{ contains(matrix.os, 'ubuntu') }}
+        run: ./.github/scripts/provision-linux-build.sh
+
+      - uses: actions/cache@0057852bfaa89a56745cba8c7296529d2fc39830 # v4.3.0
+        with:
+          path: |
+            ~/.rustup/
+            ~/.cargo/bin/
+            ~/.cargo/registry/index/
+            ~/.cargo/registry/cache/
+            ~/.cargo/git/db/
+            target/
+          key: ${{ matrix.os }}-cargo-${{ hashFiles('rust-toolchain.toml') }}-${{ hashFiles('**/Cargo.lock') }}
+
+      - name: Build icp CLI
+        run: cargo build
+
+      - name: Validate examples
+        run: ./scripts/validate-examples.sh
+
+  aggregate:
+    name: validate-examples:required
+    if: ${{ always() }}
+    runs-on: ubuntu-latest
+    needs: [validate-examples]
+    steps:
+      - name: check result
+        if: ${{ needs.validate-examples.result != 'success' }}
+        run: exit 1

examples/icp-recipe-registry-official/icp.yaml

@@ -17,7 +17,7 @@ canisters:
 
   - name: my-canister-with-version
     recipe:
-      type: "@dfinity/prebuilt@v1.0.5"
+      type: "@dfinity/prebuilt@v2.0.0"
       configuration:
         path: ../icp-pre-built/dist/hello_world.wasm
         sha256: 17a05e36278cd04c7ae6d3d3226c136267b9df7525a0657521405e22ec96be7a

examples/icp-recipe-remote-url-official/icp.yaml

@@ -3,7 +3,7 @@
 canisters:
   - name: my-canister
     recipe:
-      type: https://github.com/rikonor/icp-recipes/releases/download/prebuilt-v0.1.2/recipe.hbs
+      type: https://github.com/dfinity/icp-cli-recipes/releases/download/prebuilt-v2.0.0/recipe.hbs
       configuration:
         path: ../icp-pre-built/dist/hello_world.wasm
         sha256: 17a05e36278cd04c7ae6d3d3226c136267b9df7525a0657521405e22ec96be7a

examples/icp-recipe-remote-url/test.sh

@@ -0,0 +1,23 @@
+#!/bin/bash
+
+set -e
+
+# Start the HTTP server in the background
+python3 -m http.server 8080 &
+SERVER_PID=$!
+
+# Give the server a moment to start
+sleep 1
+
+# Function to cleanup server on exit
+cleanup() {
+    echo "Stopping HTTP server (PID: $SERVER_PID)"
+    kill $SERVER_PID 2>/dev/null || true
+    wait $SERVER_PID 2>/dev/null || true
+}
+
+# Ensure cleanup happens on script exit
+trap cleanup EXIT
+
+# Run icp project show
+icp project show

examples/icp-wasm-metadata-recipe/icp.yaml

@@ -3,7 +3,7 @@
 canisters:
   - name: my-canister
     recipe:
-      type: prebuilt
+      type: "@dfinity/prebuilt"
       configuration:
         path: ../icp-pre-built/dist/hello_world.wasm
         sha256: 17a05e36278cd04c7ae6d3d3226c136267b9df7525a0657521405e22ec96be7a

examples/icp-wasm-optimization-recipe/icp.yaml

@@ -3,7 +3,7 @@
 canisters:
   - name: my-canister
     recipe:
-      type: prebuilt
+      type: "@dfinity/prebuilt"
       configuration:
         path: ../icp-pre-built/dist/hello_world.wasm
         sha256: 17a05e36278cd04c7ae6d3d3226c136267b9df7525a0657521405e22ec96be7a

scripts/validate-examples.sh

@@ -0,0 +1,51 @@
+#!/usr/bin/env bash
+set -euo pipefail
+
+# Script to validate all examples in the examples/ directory
+# This script can be run locally or in CI
+
+# Add icp binary to PATH (assumes it's in target/debug)
+export PATH="$(pwd)/target/debug:$PATH"
+echo "icp version: $(icp --version)"
+echo "icp path: $(which icp)"
+
+# Get all example directories
+for example_dir in examples/*/; do
+  # Skip if not a directory
+  if [ ! -d "$example_dir" ]; then
+    continue
+  fi
+  
+  example_name=$(basename "$example_dir")
+  echo ""
+  echo "=========================================="
+  echo "Validating example: $example_name"
+  echo "=========================================="
+  
+  pushd "$example_dir"
+  
+  # Check if test.sh exists
+  if [ -f "test.sh" ]; then
+    echo "Found test.sh, running it..."
+    if ! bash test.sh; then
+      echo "❌ test.sh failed in $example_name"
+      exit 1
+    fi
+    echo "✅ test.sh passed for $example_name"
+  else
+    # Run icp project show to validate the project
+    echo "Running: icp project show"
+    if ! icp project show; then
+      echo "❌ Failed to validate project in $example_name"
+      exit 1
+    fi
+    echo "✅ Project validation successful for $example_name"
+  fi
+  
+  popd
+done
+
+echo ""
+echo "=========================================="
+echo "✅ All examples validated successfully!"
+echo "=========================================="