docs: add yaml schema to examples

ilbertt · ilbertt · commit 0e3e72129ee8 · 2025-11-03T13:53:48.000+01:00
In VSCode or any of its forks with the [YAML](https://marketplace.visualstudio.com/items?itemName=redhat.vscode-yaml) extension installed, adding the schema URL at the start of the file enables linting
diff --git a/examples/icp-canister-environment-variables/icp.yaml b/examples/icp-canister-environment-variables/icp.yaml
@@ -1,3 +1,5 @@
+# yaml-language-server: $schema=https://github.com/dfinity/icp-cli/raw/refs/heads/main/docs/schemas/icp-yaml-schema.json
+
 canisters:
   - name: my-canister
 
diff --git a/examples/icp-canister-settings/icp.yaml b/examples/icp-canister-settings/icp.yaml
@@ -1,3 +1,5 @@
+# yaml-language-server: $schema=https://github.com/dfinity/icp-cli/raw/refs/heads/main/docs/schemas/icp-yaml-schema.json
+
 canisters:
   - name: my-canister
 
diff --git a/examples/icp-empty/icp.yaml b/examples/icp-empty/icp.yaml
@@ -1,2 +1,4 @@
+# yaml-language-server: $schema=https://github.com/dfinity/icp-cli/raw/refs/heads/main/docs/schemas/icp-yaml-schema.json
+
 canisters:
   - canisters/*
diff --git a/examples/icp-environments/icp.yaml b/examples/icp-environments/icp.yaml
@@ -1,3 +1,5 @@
+# yaml-language-server: $schema=https://github.com/dfinity/icp-cli/raw/refs/heads/main/docs/schemas/icp-yaml-schema.json
+
 canisters:
   - name: my-canister
 
diff --git a/examples/icp-frontend-environment-variables/backend/canister.yaml b/examples/icp-frontend-environment-variables/backend/canister.yaml
@@ -1,3 +1,5 @@
+# yaml-language-server: $schema=https://github.com/dfinity/icp-cli/raw/refs/heads/main/docs/schemas/canister-yaml-schema.json
+
 name: backend
 
 build:
diff --git a/examples/icp-frontend-environment-variables/frontend/canister.yaml b/examples/icp-frontend-environment-variables/frontend/canister.yaml
@@ -1,3 +1,5 @@
+# yaml-language-server: $schema=https://github.com/dfinity/icp-cli/raw/refs/heads/main/docs/schemas/canister-yaml-schema.json
+
 name: frontend
 
 build:
diff --git a/examples/icp-frontend-environment-variables/icp.yaml b/examples/icp-frontend-environment-variables/icp.yaml
@@ -1,3 +1,5 @@
+# yaml-language-server: $schema=https://github.com/dfinity/icp-cli/raw/refs/heads/main/docs/schemas/icp-yaml-schema.json
+
 canisters:
   - backend
   - frontend
diff --git a/examples/icp-motoko-mops/icp.yaml b/examples/icp-motoko-mops/icp.yaml
@@ -1,3 +1,5 @@
+# yaml-language-server: $schema=https://github.com/dfinity/icp-cli/raw/refs/heads/main/docs/schemas/icp-yaml-schema.json
+
 canisters:
   - name: my-canister
     build:
diff --git a/examples/icp-motoko-recipe/icp.yaml b/examples/icp-motoko-recipe/icp.yaml
@@ -1,4 +1,6 @@
-canister:
+# yaml-language-server: $schema=https://github.com/dfinity/icp-cli/raw/refs/heads/main/docs/schemas/icp-yaml-schema.json
+
+canisters:
   - name: my-canister
     recipe:
       type: "@dfinity/motoko" 
diff --git a/examples/icp-motoko/icp.yaml b/examples/icp-motoko/icp.yaml
@@ -1,3 +1,5 @@
+# yaml-language-server: $schema=https://github.com/dfinity/icp-cli/raw/refs/heads/main/docs/schemas/icp-yaml-schema.json
+
 canisters:
   - name: my-canister
     build:
diff --git a/examples/icp-network-connected/icp.yaml b/examples/icp-network-connected/icp.yaml
@@ -1,3 +1,5 @@
+# yaml-language-server: $schema=https://github.com/dfinity/icp-cli/raw/refs/heads/main/docs/schemas/icp-yaml-schema.json
+
 canisters:
   - name: my-canister
 
diff --git a/examples/icp-network-connected/networks/staging.yaml b/examples/icp-network-connected/networks/staging.yaml
@@ -1,3 +1,5 @@
+# yaml-language-server: $schema=https://github.com/dfinity/icp-cli/raw/refs/heads/main/docs/schemas/network-yaml-schema.json
+
 # This "staging" network is an alias for mainnet
 # "icp deploy --network staging" would deploy a second set of canisters to mainnet
 name: staging
diff --git a/examples/icp-network-inline/icp.yaml b/examples/icp-network-inline/icp.yaml
@@ -1,3 +1,5 @@
+# yaml-language-server: $schema=https://github.com/dfinity/icp-cli/raw/refs/heads/main/docs/schemas/icp-yaml-schema.json
+
 canisters:
   - name: my-canister
 
diff --git a/examples/icp-pre-built/icp.yaml b/examples/icp-pre-built/icp.yaml
@@ -1,3 +1,5 @@
+# yaml-language-server: $schema=https://github.com/dfinity/icp-cli/raw/refs/heads/main/docs/schemas/icp-yaml-schema.json
+
 canisters:
   - name: my-canister
 
diff --git a/examples/icp-progress-bar-test-bed/icp.yaml b/examples/icp-progress-bar-test-bed/icp.yaml
@@ -1,3 +1,5 @@
+# yaml-language-server: $schema=https://github.com/dfinity/icp-cli/raw/refs/heads/main/docs/schemas/icp-yaml-schema.json
+
 canisters:
   - name: canister-1
     build:
diff --git a/examples/icp-project-multi-canister-inline/icp.yaml b/examples/icp-project-multi-canister-inline/icp.yaml
@@ -1,3 +1,5 @@
+# yaml-language-server: $schema=https://github.com/dfinity/icp-cli/raw/refs/heads/main/docs/schemas/icp-yaml-schema.json
+
 canisters:
   - name: canister-1
     build:
diff --git a/examples/icp-project-multi-canister/canisters/canister-1/canister.yaml b/examples/icp-project-multi-canister/canisters/canister-1/canister.yaml
@@ -1,3 +1,5 @@
+# yaml-language-server: $schema=https://github.com/dfinity/icp-cli/raw/refs/heads/main/docs/schemas/canister-yaml-schema.json
+
 name: canister-1
 
 build:
diff --git a/examples/icp-project-multi-canister/canisters/canister-2/canister.yaml b/examples/icp-project-multi-canister/canisters/canister-2/canister.yaml
@@ -1,3 +1,5 @@
+# yaml-language-server: $schema=https://github.com/dfinity/icp-cli/raw/refs/heads/main/docs/schemas/canister-yaml-schema.json
+
 name: canister-2
 
 build:
diff --git a/examples/icp-project-multi-canister/icp.yaml b/examples/icp-project-multi-canister/icp.yaml
@@ -1,2 +1,4 @@
+# yaml-language-server: $schema=https://github.com/dfinity/icp-cli/raw/refs/heads/main/docs/schemas/icp-yaml-schema.json
+
 canisters:
   - canisters/*
diff --git a/examples/icp-project-single-canister/icp.yaml b/examples/icp-project-single-canister/icp.yaml
@@ -1,3 +1,5 @@
+# yaml-language-server: $schema=https://github.com/dfinity/icp-cli/raw/refs/heads/main/docs/schemas/icp-yaml-schema.json
+
 canisters:
   - name: my-canister
 
diff --git a/examples/icp-recipe-local-file/icp.yaml b/examples/icp-recipe-local-file/icp.yaml
@@ -1,3 +1,5 @@
+# yaml-language-server: $schema=https://github.com/dfinity/icp-cli/raw/refs/heads/main/docs/schemas/icp-yaml-schema.json
+
 canisters:
   - name: my-canister
     recipe:
diff --git a/examples/icp-recipe-registry-official/icp.yaml b/examples/icp-recipe-registry-official/icp.yaml
@@ -1,3 +1,5 @@
+# yaml-language-server: $schema=https://github.com/dfinity/icp-cli/raw/refs/heads/main/docs/schemas/icp-yaml-schema.json
+
 canisters:
   - name: my-canister
     recipe:
diff --git a/examples/icp-recipe-remote-url-official/icp.yaml b/examples/icp-recipe-remote-url-official/icp.yaml
@@ -1,3 +1,5 @@
+# yaml-language-server: $schema=https://github.com/dfinity/icp-cli/raw/refs/heads/main/docs/schemas/icp-yaml-schema.json
+
 canisters:
   - name: my-canister
     recipe:
diff --git a/examples/icp-recipe-remote-url/icp.yaml b/examples/icp-recipe-remote-url/icp.yaml
@@ -1,3 +1,5 @@
+# yaml-language-server: $schema=https://github.com/dfinity/icp-cli/raw/refs/heads/main/docs/schemas/icp-yaml-schema.json
+
 canisters:
   - name: my-canister
     recipe:
diff --git a/examples/icp-rust-recipe/icp.yaml b/examples/icp-rust-recipe/icp.yaml
@@ -1,3 +1,5 @@
+# yaml-language-server: $schema=https://github.com/dfinity/icp-cli/raw/refs/heads/main/docs/schemas/icp-yaml-schema.json
+
 canisters:
   - name: my-canister
     recipe:
diff --git a/examples/icp-rust/icp.yaml b/examples/icp-rust/icp.yaml
@@ -1,8 +1,10 @@
+# yaml-language-server: $schema=https://github.com/dfinity/icp-cli/raw/refs/heads/main/docs/schemas/icp-yaml-schema.json
+
 canisters:
-  name: my-canister
-  build:
-    steps:
-      - type: script
-        commands:
-          - cargo build --target wasm32-unknown-unknown --release --locked
-          - mv target/wasm32-unknown-unknown/release/icp_template_rust.wasm "$ICP_WASM_OUTPUT_PATH"
+  - name: my-canister
+    build:
+      steps:
+        - type: script
+          commands:
+            - cargo build --target wasm32-unknown-unknown --release --locked
+            - mv target/wasm32-unknown-unknown/release/icp_template_rust.wasm "$ICP_WASM_OUTPUT_PATH"
diff --git a/examples/icp-static-assets-recipe/icp.yaml b/examples/icp-static-assets-recipe/icp.yaml
@@ -1,3 +1,5 @@
+# yaml-language-server: $schema=https://github.com/dfinity/icp-cli/raw/refs/heads/main/docs/schemas/icp-yaml-schema.json
+
 canisters:
   - name: my-canister
     recipe:
diff --git a/examples/icp-static-assets/icp.yaml b/examples/icp-static-assets/icp.yaml
@@ -1,3 +1,5 @@
+# yaml-language-server: $schema=https://github.com/dfinity/icp-cli/raw/refs/heads/main/docs/schemas/icp-yaml-schema.json
+
 canisters:
   - name: my-canister
 
diff --git a/examples/icp-static-react-site/icp.yaml b/examples/icp-static-react-site/icp.yaml
@@ -1,3 +1,5 @@
+# yaml-language-server: $schema=https://github.com/dfinity/icp-cli/raw/refs/heads/main/docs/schemas/icp-yaml-schema.json
+
 canisters:
   - name: my-canister
 
diff --git a/examples/icp-sync/icp.yaml b/examples/icp-sync/icp.yaml
@@ -1,3 +1,5 @@
+# yaml-language-server: $schema=https://github.com/dfinity/icp-cli/raw/refs/heads/main/docs/schemas/icp-yaml-schema.json
+
 canisters:
   - name: my-canister
 
diff --git a/examples/icp-wasm-metadata-recipe/icp.yaml b/examples/icp-wasm-metadata-recipe/icp.yaml
@@ -1,3 +1,5 @@
+# yaml-language-server: $schema=https://github.com/dfinity/icp-cli/raw/refs/heads/main/docs/schemas/icp-yaml-schema.json
+
 canisters:
   - name: my-canister
     recipe:
diff --git a/examples/icp-wasm-metadata/icp.yaml b/examples/icp-wasm-metadata/icp.yaml
@@ -1,3 +1,5 @@
+# yaml-language-server: $schema=https://github.com/dfinity/icp-cli/raw/refs/heads/main/docs/schemas/icp-yaml-schema.json
+
 canisters:
   - name: my-canister
 
diff --git a/examples/icp-wasm-optimization-recipe/icp.yaml b/examples/icp-wasm-optimization-recipe/icp.yaml
@@ -1,3 +1,5 @@
+# yaml-language-server: $schema=https://github.com/dfinity/icp-cli/raw/refs/heads/main/docs/schemas/icp-yaml-schema.json
+
 canisters:
   - name: my-canister
     recipe:
diff --git a/examples/icp-wasm-optimization/icp.yaml b/examples/icp-wasm-optimization/icp.yaml
@@ -1,3 +1,5 @@
+# yaml-language-server: $schema=https://github.com/dfinity/icp-cli/raw/refs/heads/main/docs/schemas/icp-yaml-schema.json
+
 canisters:
   - name: my-canister
 

Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,5 @@`
	`1`	`+# yaml-language-server: $schema=https://github.com/dfinity/icp-cli/raw/refs/heads/main/docs/schemas/icp-yaml-schema.json`
	`2`	`+`
`1`	`3`	`canisters:`
`2`	`4`	`- name: my-canister`
`3`	`5`
Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,5 @@`
	`1`	`+# yaml-language-server: $schema=https://github.com/dfinity/icp-cli/raw/refs/heads/main/docs/schemas/canister-yaml-schema.json`
	`2`	`+`
`1`	`3`	`name: backend`
`2`	`4`
`3`	`5`	`build:`
Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,5 @@`
	`1`	`+# yaml-language-server: $schema=https://github.com/dfinity/icp-cli/raw/refs/heads/main/docs/schemas/canister-yaml-schema.json`
	`2`	`+`
`1`	`3`	`name: frontend`
`2`	`4`
`3`	`5`	`build:`