Skip to content

docs: add yaml schema to examples #183

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
wants to merge 7 commits into
base: main
Choose a base branch
from
Draft

docs: add yaml schema to examples #183

Show file tree
Hide file tree
Changes from 5 commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
0e3e721
docs: add yaml schema to examples
ilbertt Nov 3, 2025
1e139b2
Merge branch 'main' into luca/yaml-schemas
ilbertt Nov 3, 2025
952b29a
Merge branch 'main' into luca/yaml-schemas
ilbertt Nov 4, 2025
a4466e2
Merge branch 'main' into luca/yaml-schemas
ilbertt Nov 4, 2025
044af4e
Merge branch 'main' into luca/yaml-schemas
ilbertt Nov 5, 2025
951d5db
Merge branch 'main' into luca/yaml-schemas
ilbertt Nov 11, 2025
648bade
Merge branch 'main' into luca/yaml-schemas
ilbertt Nov 17, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions examples/icp-canister-environment-variables/icp.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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

Expand Down
2 changes: 2 additions & 0 deletions examples/icp-canister-settings/icp.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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

Expand Down
2 changes: 2 additions & 0 deletions examples/icp-empty/icp.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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/*
2 changes: 2 additions & 0 deletions examples/icp-environments/icp.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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

Expand Down
2 changes: 2 additions & 0 deletions examples/icp-frontend-environment-variables/backend/canister.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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:
Expand Down
2 changes: 2 additions & 0 deletions examples/icp-frontend-environment-variables/frontend/canister.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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:
Expand Down
2 changes: 2 additions & 0 deletions examples/icp-frontend-environment-variables/icp.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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
2 changes: 2 additions & 0 deletions examples/icp-motoko-mops/icp.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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:
Expand Down
4 changes: 3 additions & 1 deletion examples/icp-motoko-recipe/icp.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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"
Expand Down
2 changes: 2 additions & 0 deletions examples/icp-motoko/icp.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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:
Expand Down
2 changes: 2 additions & 0 deletions examples/icp-network-connected/icp.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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

Expand Down
2 changes: 2 additions & 0 deletions examples/icp-network-connected/networks/staging.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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
Expand Down
2 changes: 2 additions & 0 deletions examples/icp-network-inline/icp.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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

Expand Down
2 changes: 2 additions & 0 deletions examples/icp-pre-built/icp.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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

Expand Down
2 changes: 2 additions & 0 deletions examples/icp-progress-bar-test-bed/icp.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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:
Expand Down
2 changes: 2 additions & 0 deletions examples/icp-project-multi-canister-inline/icp.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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:
Expand Down
2 changes: 2 additions & 0 deletions examples/icp-project-multi-canister/canisters/canister-1/canister.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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:
Expand Down
2 changes: 2 additions & 0 deletions examples/icp-project-multi-canister/canisters/canister-2/canister.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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:
Expand Down
2 changes: 2 additions & 0 deletions examples/icp-project-multi-canister/icp.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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/*
2 changes: 2 additions & 0 deletions examples/icp-project-single-canister/icp.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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

Expand Down
2 changes: 2 additions & 0 deletions examples/icp-recipe-local-file/icp.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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:
Expand Down
2 changes: 2 additions & 0 deletions examples/icp-recipe-registry-official/icp.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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:
Expand Down
2 changes: 2 additions & 0 deletions examples/icp-recipe-remote-url-official/icp.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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:
Expand Down
2 changes: 2 additions & 0 deletions examples/icp-recipe-remote-url/icp.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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:
Expand Down
2 changes: 2 additions & 0 deletions examples/icp-rust-recipe/icp.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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:
Expand Down
16 changes: 9 additions & 7 deletions examples/icp-rust/icp.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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"
2 changes: 2 additions & 0 deletions examples/icp-static-assets-recipe/icp.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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:
Expand Down
2 changes: 2 additions & 0 deletions examples/icp-static-assets/icp.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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

Expand Down
2 changes: 2 additions & 0 deletions examples/icp-static-react-site/icp.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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

Expand Down
2 changes: 2 additions & 0 deletions examples/icp-sync/icp.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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

Expand Down
2 changes: 2 additions & 0 deletions examples/icp-wasm-metadata-recipe/icp.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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:
Expand Down
2 changes: 2 additions & 0 deletions examples/icp-wasm-metadata/icp.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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

Expand Down
2 changes: 2 additions & 0 deletions examples/icp-wasm-optimization-recipe/icp.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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:
Expand Down
2 changes: 2 additions & 0 deletions examples/icp-wasm-optimization/icp.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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

Expand Down