Skip to content

Commit 5fa868f

Browse files
committed
docs(ignition): add environment variable reference
Added docs for: * `HARDHAT_IGNITION_CONFIRM_DEPLOYMENT` * `HARDHAT_IGNITION_CONFIRM_RESET`
1 parent cfd6fb6 commit 5fa868f

File tree

3 files changed

+11
-0
lines changed

3 files changed

+11
-0
lines changed
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
section-type: group
2+
section-title: Reference
3+
order:
4+
- /environment-variables
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
# Environment variables
2+
3+
Hardhat Ignition supports special environment variables that affects how deployment works:
4+
5+
- `HARDHAT_IGNITION_CONFIRM_DEPLOYMENT`: if set to `false`, Hardhat Ignition won't prompt the user asking for confirmation when deploying to a live network. This prompt is already not shown when running against the local Hardhat network (chainId: 31337), but you might want to set this variable if writing fully automated scripts that leverage Hardhat Ignition.
6+
- `HARDHAT_IGNITION_CONFIRM_RESET`: if set to `false`, Hardhat Ignition won't prompt the user asking for confirmation when overwritting the previous deployment via the `--reset` flag on Hardhat Ignition's `deploy` task.

docs/src/content/layouts.yaml

+1
Original file line numberDiff line numberDiff line change
@@ -55,6 +55,7 @@ ignition:
5555
- ignition/docs/config
5656
- ignition/docs/guides
5757
- ignition/docs/advanced
58+
- ignition/docs/reference
5859
- ignition/docs/other-components
5960

6061
hidden:

0 commit comments

Comments
 (0)