Skip to content

Commit

Permalink
Updated variables.
Browse files Browse the repository at this point in the history
  • Loading branch information
AlexSkrypnyk committed Apr 29, 2024
1 parent 5168715 commit 19e43b8
Showing 1 changed file with 46 additions and 6 deletions.
52 changes: 46 additions & 6 deletions .scaffold/docs/content/workflows/variables.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -645,7 +645,7 @@ Defined in: `scripts/drevops/deploy-webhook.sh`

### `DREVOPS_DEPLOY_WEBHOOK_URL`

The URL of the webhook to call.<br />Note that any tokens should be added to the value of this variable outside<br />this script.
The URL of the webhook to call.

Default value: `UNDEFINED`

Expand Down Expand Up @@ -951,7 +951,7 @@ Deployment environment URL.

Default value: `UNDEFINED`

Defined in: `scripts/drevops/notify-github.sh`, `scripts/drevops/notify-jira.sh`
Defined in: `scripts/drevops/notify-github.sh`, `scripts/drevops/notify-jira.sh`, `scripts/drevops/notify-webhook.sh`

### `DREVOPS_NOTIFY_EVENT`

Expand Down Expand Up @@ -1107,19 +1107,19 @@ Defined in: `scripts/drevops/notify-newrelic.sh`

### `DREVOPS_NOTIFY_PROJECT`

The project to notify about.
Project name to notify.

Default value: `${DREVOPS_PROJECT}`
Default value: `UNDEFINED`

Defined in: `scripts/drevops/notify.sh`
Defined in: `scripts/drevops/notify-webhook.sh`, `scripts/drevops/notify.sh`

### `DREVOPS_NOTIFY_REF`

Deployment reference, such as a git SHA.

Default value: `UNDEFINED`

Defined in: `scripts/drevops/notify-github.sh`
Defined in: `scripts/drevops/notify-github.sh`, `scripts/drevops/notify-webhook.sh`

### `DREVOPS_NOTIFY_REPOSITORY`

Expand All @@ -1137,6 +1137,46 @@ Default value: `UNDEFINED`

Defined in: `scripts/drevops/notify.sh`

### `DREVOPS_NOTIFY_WEBHOOK_HEADERS`

Webhook headers.<br />Ex: "Content-type: application/json;Authorization: Bearer API_KEY".

Default value: `Content-type: application/json`

Defined in: `scripts/drevops/notify-webhook.sh`

### `DREVOPS_NOTIFY_WEBHOOK_METHOD`

Webhook method like POST, GET, PUT.

Default value: `POST`

Defined in: `scripts/drevops/notify-webhook.sh`

### `DREVOPS_NOTIFY_WEBHOOK_PAYLOAD`

Webhook message body as json format.<br />This is data sent to webhook.<br />Some built-in variables like: %message%, %environment_url%, %project%, %ref%, %timestamp%.<br />Ex: {"channel": "Channel `1`", "message": "%message%"}.

Default value: `${DREVOPS_NOTIFY_WEBHOOK_PAYLOAD:-{\"channel\": \"Channel 1\", \"message\": \"%message%\", \"project\": \"%project%\", \"ref\": \"%ref%\", \"timestamp\": \"%timestamp%\", \"environment_url\": \"%environment_url%\"}}`

Defined in: `scripts/drevops/notify-webhook.sh`

### `DREVOPS_NOTIFY_WEBHOOK_RESPONSE_STATUS`

The pattern of response code return by curl.<br />Default is match `200`.

Default value: `200`

Defined in: `scripts/drevops/notify-webhook.sh`

### `DREVOPS_NOTIFY_WEBHOOK_URL`

Webhook URL.

Default value: `UNDEFINED`

Defined in: `scripts/drevops/notify-webhook.sh`

### `DREVOPS_NPM_VERBOSE`

Print output from NPM install.
Expand Down

0 comments on commit 19e43b8

Please sign in to comment.