Skip to content

Commit 1bcae2d

Browse files
committed
add global parameters to docs
1 parent cd5581c commit 1bcae2d

File tree

1 file changed

+21
-0
lines changed
  • docs/src/content/ignition/docs/guides

1 file changed

+21
-0
lines changed

docs/src/content/ignition/docs/guides/deploy.md

+21
Original file line numberDiff line numberDiff line change
@@ -40,6 +40,12 @@ An example file could be called `./ignition/parameters.json` and contain the fol
4040
}
4141
```
4242

43+
:::tip
44+
45+
`JSON5` format is also supported for parameter files!
46+
47+
:::
48+
4349
This makes the `name` parameter for the `Apollo` module be `"Saturn V"`.
4450

4551
To execute a deployment using parameters, you need to use the `--parameters` argument, like this:
@@ -74,6 +80,21 @@ To pass a `bigint` as a Module parameter, you can encode it as a string. Any str
7480
}
7581
```
7682

83+
You can also define global parameters that will be available to all modules. To do this, define a `$global` key in the parameters file:
84+
85+
```json
86+
{
87+
"$global": {
88+
"shouldBeAllowed": true
89+
},
90+
"MyModule": {
91+
"shouldBeAllowed": false
92+
}
93+
}
94+
```
95+
96+
In this example, the `shouldBeAllowed` parameter will be `true` for all modules except `MyModule`, where it will be `false`. Global parameters can be accessed in the same way as module parameters.
97+
7798
## Inspecting an existing deployment
7899

79100
To get a list of all the deployment IDs that exist in the current project, run:

0 commit comments

Comments
 (0)