Skip to content

Commit cf9deca

Browse files
committed
update docs
1 parent aceef2e commit cf9deca

File tree

1 file changed

+8
-0
lines changed

1 file changed

+8
-0
lines changed

docs/custom-deployment-messages.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,8 +17,16 @@ If a markdown file exists at the designated path, it will be used and rendered w
1717
- `status` - The status of the deployment (String) - `success`, `failure`, or `unknown`
1818
- `noop` - Whether or not the deployment is a noop (Boolean)
1919
- `ref` - The ref of the deployment (String)
20+
- `sha` - The sha of the deployment (String)
2021
- `actor` - The GitHub username of the actor who triggered the deployment (String)
2122
- `approved_reviews_count` - The number of approved reviews on the pull request at the time of deployment (String of a number)
23+
- `review_decision` - The review status of the pull request (String or null) - Ex: `APPROVED`, `REVIEW_REQUIRED`, `CHANGES_REQUESTED`, `null` etc.
24+
- `deployment_id` - The ID of the deployment (Int or null in the case of `.noop` deployments)
25+
- `fork` - Whether or not the repository is a fork (Boolean)
26+
- `params` - The raw string of deployment parameters (String)
27+
- `parsed_params` - A string representation of the parsed deployment parameters (String)
28+
- `deployment_end_time` - The time the deployment ended - this value is not _exact_ but it is very close (String) [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) UTC format
29+
- `logs` - The URL to the logs of the deployment (String)
2230

2331
If you wish to see a live example of how this works, and how to use the variables, you can check out this [example](https://github.com/github/branch-deploy/blob/37b50ea86202af7b5505b62bf3eb326da0614b60/__tests__/templates/test_deployment_message.md) which is used in this repo's unit tests and is self-documenting.
2432

0 commit comments

Comments
 (0)