GitHub Action
Gruntwork Patcher
v1.1.5
Latest version
A GitHub Action for running Patcher.
Important
Patcher is currently in beta and is only available to Gruntwork customers. If you're interested in using Patcher to update your Terraform/Terragrunt dependencies, please contact our sales team at [email protected].
You can find out more about Gruntwork Patcher at gruntwork.io and by reading the latest docs.
Refer to the /examples/github/workflows folder for use cases of the action.
It will run patcher update in the whole repo, and open a Pull Request with the changes.
steps:
- uses: actions/checkout@v3
- uses: gruntwork-io/patcher-action| Name | Description | Default |
|---|---|---|
github_token |
GitHub's Personal Access Token (PAT). | GITHUB_TOKEN |
patcher_command |
Patcher command to run. Valid options: update or report. |
update |
working_dir |
Directory where Patcher should run. If empty, it will run in the whole repo. | |
update_strategy |
Update strategy. Only used when running update. Valid options: next-safe or next-breaking. Refer to the "Update Strategies" documentation. |
next-breaking |
dependency |
Target the update to a single dependency. Only used when running update. Format: <org>/<repo>/<name>. Example: gruntwork-io/terraform-aws-service-catalog/services/ecs-module. |
|
commit_author |
Author of the Pull Request's commits in the format Name <[email protected]>. Only used when running update. The permissions to push the changes and to create the Pull Request are from 'github_token'. |
gruntwork-patcher-bot <[email protected]> |
dependencies: Terraform and Terragrunt dependencies from the given directory. Only works forreport.
Refer to the Promotion Workflows with Terraform.
If you need to make changes to the action, you can build it locally with the following commands:
# install dependencies
yarn
# run the tests
yarn test
# build a release
yarn build