diff --git a/docs/src/content/docs/configuration-reference/hooks.mdx b/docs/src/content/docs/configuration-reference/hooks.mdx index 55dc93eb..9fb5cc60 100644 --- a/docs/src/content/docs/configuration-reference/hooks.mdx +++ b/docs/src/content/docs/configuration-reference/hooks.mdx @@ -50,8 +50,11 @@ The `run` hook type executes a command from the directory that Terrateam is oper | Key | Type | Description | |-----|------|-------------| | cmd | List | Command to run. | -| run_on | String | Run the command on step success, failure, or always. Default is success. | -| capture_output | Boolean | When set to true, command output is included in the GitHub pull request comment on a failure. Sensitive data is not masked. Be aware, this data is sent back to the Terrateam server for processing. Default is false. | +| run_on | String | Run the command depending on the state of the workflow. Options are `success`, `failure`, or `always`. Default is `success`. | +| capture_output | Boolean | When set to `true`, command output is recorded. Secrets are masked with `***`. Default is `true`. | +| env | Object | Environment variables to set for this execution. Object keys are environment variable names and the value is a string. | +| ignore_errors | Boolean | Set to `true` if failure should be ignored. Default is `false.` | +| visible_on | String | When the output of the command should be visible in a PR comment or the UI. Options are `always`, `failure`, `success`. Default is `failure`. | ### `oidc` The `oidc` hook type can be used to initiate an OIDC connection to a cloud provider. diff --git a/docs/src/content/docs/configuration-reference/workflows.mdx b/docs/src/content/docs/configuration-reference/workflows.mdx index 8c5934d1..8f7d0f91 100644 --- a/docs/src/content/docs/configuration-reference/workflows.mdx +++ b/docs/src/content/docs/configuration-reference/workflows.mdx @@ -87,9 +87,11 @@ Custom commands can be run using the `run` step type. | Key | Type | Description | |-----|------|-------------| | cmd | List | Command to run from the directory that Terrateam is operating against. | -| run_on | String | Run the command on step `success`, `failure`, or `always`. Default is `success`. | -| capture_output | Boolean | When set to `true`, command output is included in the GitHub pull request comment on a failure. Sensitive data is not masked. Be aware, this data is sent back to the Terrateam server for processing. Default is `false`. | +| run_on | String | Run the command depending on the state of the workflow. Options are `success`, `failure`, or `always`. Default is `success`. | +| capture_output | Boolean | When set to `true`, command output is recorded. Secrets are masked with `***`. Default is `true`. | | env | Object | Environment variables to set for this execution. Object keys are environment variable names and the value is a string. | +| ignore_errors | Boolean | Set to `true` if failure should be ignored. Default is `false.` | +| visible_on | String | When the output of the command should be visible in a PR comment or the UI. Options are `always`, `failure`, `success`. Default is `failure`. | ### OIDC An OIDC connection to a cloud provider can be initiated using the `oidc` step type, which supports AWS and GCP providers.