diff --git a/README.md b/README.md index f3fa1e1b..2ae38228 100644 --- a/README.md +++ b/README.md @@ -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 @@ -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 diff --git a/action.yml b/action.yml index 7ec3f29c..8f1103f5 100644 --- a/action.yml +++ b/action.yml @@ -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'