Skip to content

Commit

Permalink
docs: Document additional params
Browse files Browse the repository at this point in the history
  • Loading branch information
colinjfw committed Sep 1, 2019
1 parent 9036930 commit bafcbde
Show file tree
Hide file tree
Showing 2 changed files with 20 additions and 0 deletions.
12 changes: 12 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,10 @@ payload of the deployment resource.
- `dry-run`: Helm dry-run option.
- `token`: Github repository token. If included and the event is a deployment
then the deployment_status event will be fired.
- `value-files`: Additional value files to apply to the helm chart. Expects a
JSON encoded array or a string. (deployment).
- `secrets`: Secret variables to include in value file interpolation. Expects a
JSON encoded map.

Additional parameters: If the action is being triggered by a deployment event
and the `task` parameter in the deployment event is set to `"remove"` then this
Expand All @@ -34,6 +38,14 @@ action will execute a `helm delete $service`

- `KUBECONFIG_FILE`: Kubeconfig file for Kubernetes cluster access.

### Value file interpolation

The following syntax allows variables to be used in value files:

- `${{ secrets.KEY }}`: References secret variables passed in the secrets input.
- `${{ deployment }}`: References the deployment event that triggered this
action.

## Example

```yaml
Expand Down
8 changes: 8 additions & 0 deletions action.yml
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,14 @@ inputs:
description: >
Github repository token. If included and the event is a deployment then
the deployment_status event will be fired.
value-files:
description: >
Additional value files to apply to the helm chart. Expects a
JSON encoded array or a string. (deployment)
secrets:
description: >
Secret variables to include in value file interpolation. Expects a
JSON encoded map.
runs:
using: 'docker'
image: 'Dockerfile'

0 comments on commit bafcbde

Please sign in to comment.