{"id":28566765,"url":"https://github.com/gruntwork-io/patcher-action","last_synced_at":"2026-03-08T05:01:58.918Z","repository":{"id":177687368,"uuid":"656622992","full_name":"gruntwork-io/patcher-action","owner":"gruntwork-io","description":"A GitHub Action for running Patcher, including setting up promotion workflows.","archived":false,"fork":false,"pushed_at":"2026-03-02T17:36:49.000Z","size":1984,"stargazers_count":21,"open_issues_count":6,"forks_count":5,"subscribers_count":8,"default_branch":"main","last_synced_at":"2026-03-04T13:59:47.947Z","etag":null,"topics":["cicd","devops","terraform","updater"],"latest_commit_sha":null,"homepage":"https://gruntwork.io/patcher/","language":"HCL","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/gruntwork-io.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2023-06-21T10:02:31.000Z","updated_at":"2026-03-03T19:12:43.000Z","dependencies_parsed_at":"2024-03-06T19:02:45.225Z","dependency_job_id":"75ada0a5-4d37-4daf-8ee5-91bb30a8862d","html_url":"https://github.com/gruntwork-io/patcher-action","commit_stats":null,"previous_names":["gruntwork-io/patcher-action"],"tags_count":44,"template":false,"template_full_name":null,"purl":"pkg:github/gruntwork-io/patcher-action","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/gruntwork-io%2Fpatcher-action","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/gruntwork-io%2Fpatcher-action/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/gruntwork-io%2Fpatcher-action/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/gruntwork-io%2Fpatcher-action/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/gruntwork-io","download_url":"https://codeload.github.com/gruntwork-io/patcher-action/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/gruntwork-io%2Fpatcher-action/sbom","scorecard":{"id":446899,"data":{"date":"2025-08-11","repo":{"name":"github.com/gruntwork-io/patcher-action","commit":"ec83ca1707219ad48b97c3dc2806748261026203"},"scorecard":{"version":"v5.2.1-40-gf6ed084d","commit":"f6ed084d17c9236477efd66e5b258b9d4cc7b389"},"score":4,"checks":[{"name":"Code-Review","score":1,"reason":"Found 3/17 approved changesets -- score normalized to 1","details":null,"documentation":{"short":"Determines if the project requires human code review before pull requests (aka merge requests) are merged.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#code-review"}},{"name":"Binary-Artifacts","score":10,"reason":"no binaries found in the repo","details":null,"documentation":{"short":"Determines if the project has generated executable (binary) artifacts in the source repository.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#binary-artifacts"}},{"name":"Maintained","score":5,"reason":"7 commit(s) and 0 issue activity found in the last 90 days -- score normalized to 5","details":null,"documentation":{"short":"Determines if the project is \"actively maintained\".","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#maintained"}},{"name":"Packaging","score":-1,"reason":"packaging workflow not detected","details":["Warn: no GitHub/GitLab publishing workflow detected."],"documentation":{"short":"Determines if the project is published as a package that others can easily download, install, easily update, and uninstall.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#packaging"}},{"name":"Dangerous-Workflow","score":10,"reason":"no dangerous workflow patterns detected","details":null,"documentation":{"short":"Determines if the project's GitHub Action workflows avoid dangerous patterns.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#dangerous-workflow"}},{"name":"CII-Best-Practices","score":0,"reason":"no effort to earn an OpenSSF best practices badge detected","details":null,"documentation":{"short":"Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#cii-best-practices"}},{"name":"Token-Permissions","score":0,"reason":"detected GitHub workflow tokens with excessive permissions","details":["Warn: no topLevel permission defined: .github/workflows/ci.yml:1","Warn: no topLevel permission defined: .github/workflows/increment-version.yml:1","Warn: no topLevel permission defined: .github/workflows/release.yml:1","Warn: no topLevel permission defined: .github/workflows/test.yml:1","Info: no jobLevel write permissions found"],"documentation":{"short":"Determines if the project's workflows follow the principle of least privilege.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#token-permissions"}},{"name":"Pinned-Dependencies","score":0,"reason":"dependency not pinned by hash detected -- score normalized to 0","details":["Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/ci.yml:26: update your workflow using https://app.stepsecurity.io/secureworkflow/gruntwork-io/patcher-action/ci.yml/main?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/ci.yml:28: update your workflow using https://app.stepsecurity.io/secureworkflow/gruntwork-io/patcher-action/ci.yml/main?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/ci.yml:48: update your workflow using https://app.stepsecurity.io/secureworkflow/gruntwork-io/patcher-action/ci.yml/main?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/ci.yml:59: update your workflow using https://app.stepsecurity.io/secureworkflow/gruntwork-io/patcher-action/ci.yml/main?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/ci.yml:74: update your workflow using https://app.stepsecurity.io/secureworkflow/gruntwork-io/patcher-action/ci.yml/main?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/ci.yml:76: update your workflow using https://app.stepsecurity.io/secureworkflow/gruntwork-io/patcher-action/ci.yml/main?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/ci.yml:13: update your workflow using https://app.stepsecurity.io/secureworkflow/gruntwork-io/patcher-action/ci.yml/main?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/ci.yml:15: update your workflow using https://app.stepsecurity.io/secureworkflow/gruntwork-io/patcher-action/ci.yml/main?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/increment-version.yml:12: update your workflow using https://app.stepsecurity.io/secureworkflow/gruntwork-io/patcher-action/increment-version.yml/main?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/test.yml:38: update your workflow using https://app.stepsecurity.io/secureworkflow/gruntwork-io/patcher-action/test.yml/main?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/test.yml:40: update your workflow using https://app.stepsecurity.io/secureworkflow/gruntwork-io/patcher-action/test.yml/main?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/test.yml:14: update your workflow using https://app.stepsecurity.io/secureworkflow/gruntwork-io/patcher-action/test.yml/main?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/test.yml:23: update your workflow using https://app.stepsecurity.io/secureworkflow/gruntwork-io/patcher-action/test.yml/main?enable=pin","Info:   0 out of  13 GitHub-owned GitHubAction dependencies pinned"],"documentation":{"short":"Determines if the project has declared and pinned the dependencies of its build process.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#pinned-dependencies"}},{"name":"Security-Policy","score":0,"reason":"security policy file not detected","details":["Warn: no security policy file detected","Warn: no security file to analyze","Warn: no security file to analyze","Warn: no security file to analyze"],"documentation":{"short":"Determines if the project has published a security policy.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#security-policy"}},{"name":"Fuzzing","score":0,"reason":"project is not fuzzed","details":["Warn: no fuzzer integrations found"],"documentation":{"short":"Determines if the project uses fuzzing.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#fuzzing"}},{"name":"License","score":10,"reason":"license file detected","details":["Info: project has a license file: LICENSE:0","Info: FSF or OSI recognized license: Apache License 2.0: LICENSE:0"],"documentation":{"short":"Determines if the project has defined a license.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#license"}},{"name":"Signed-Releases","score":-1,"reason":"no releases found","details":null,"documentation":{"short":"Determines if the project cryptographically signs release artifacts.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#signed-releases"}},{"name":"Branch-Protection","score":-1,"reason":"internal error: error during branchesHandler.setup: internal error: githubv4.Query: Resource not accessible by integration","details":null,"documentation":{"short":"Determines if the default and release branches are protected with GitHub's branch protection settings.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#branch-protection"}},{"name":"Vulnerabilities","score":6,"reason":"4 existing vulnerabilities detected","details":["Warn: Project is vulnerable to: GHSA-h5c3-5r3r-rr8q","Warn: Project is vulnerable to: GHSA-rmvr-2pp2-xj38","Warn: Project is vulnerable to: GHSA-xx4v-prfh-6cgc","Warn: Project is vulnerable to: GHSA-v6h2-p8h4-qcjw"],"documentation":{"short":"Determines if the project has open, known unfixed vulnerabilities.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#vulnerabilities"}},{"name":"SAST","score":0,"reason":"SAST tool is not run on all commits -- score normalized to 0","details":["Warn: 0 commits out of 22 are checked with a SAST tool"],"documentation":{"short":"Determines if the project uses static code analysis.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#sast"}}]},"last_synced_at":"2025-08-19T06:59:31.151Z","repository_id":177687368,"created_at":"2025-08-19T06:59:31.151Z","updated_at":"2025-08-19T06:59:31.151Z"},"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":30246626,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-03-08T00:58:18.660Z","status":"online","status_checked_at":"2026-03-08T02:00:06.215Z","response_time":56,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["cicd","devops","terraform","updater"],"created_at":"2025-06-10T15:30:58.927Z","updated_at":"2026-03-08T05:01:58.848Z","avatar_url":"https://github.com/gruntwork-io.png","language":"HCL","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Patcher Action\n\nReusable GitHub Actions workflow to discover, update, and PR Terragrunt deps using [Patcher](https://github.com/gruntwork-io/patcher-cli).\n\n## How the workflow runs\n\nThe workflow (`.github/workflows/patcher.yml`) is a **single job** that:\n\n1. **Checks out your infrastructure repo** so changes can be made.\n2. **Installs Patcher and Terrapatch**.\n3. **Runs Patcher to detect outdated dependencies** and generates an upgrade spec (such as `spec.json`).\n4. **Uploads the upgrade spec** as an artifact for later viewing/use.\n5. **Runs Patcher to apply updates** using the spec and **automatically opens a Pull Request** with any changes found (if updates are required).\n\nThis process is fully automated—just call the workflow, and it will discover, update, and PR Terragrunt dependencies as needed.\n\n\n## Requirements\n\n### Repo layout\n\nThe workflow expects to be invoked from (or for) the **repository that contains your Terragrunt/infrastructure code**. It checks out that repo into `infra-live-repo` and runs Patcher there.\n\n## Resiliency\n\nThe following secrets are only needed if you are **not** using OIDC, or if your setup requires explicit tokens as a fallback:\n\n| Secret | Purpose |\n|--------|--------|\n| `PIPELINES_READ_TOKEN` | Download Patcher/Terrapatch, read Gruntwork modules and your repos. Used as a fallback when OIDC is not available. |\n| `PR_CREATE_TOKEN` | Push branches and create Pull Requests in your infrastructure repo. Used as a fallback when OIDC is not available. |\n\n## How to use it\n\nCall the reusable workflow from your repo. Minimal example:\n\n```yaml\njobs:\n  patcher:\n    uses: gruntwork-io/patcher-action/.github/workflows/patcher.yml@v5\n    with:\n      working_dir: ./\n      include_dirs: \"{*dev*}/**\"   # optional: limit report to dirs matching this glob\n    secrets:\n      PIPELINES_READ_TOKEN: ${{ secrets.PIPELINES_READ_TOKEN }}\n      PR_CREATE_TOKEN: ${{ secrets.PR_CREATE_TOKEN }}\n```\n\n## Key inputs\n\n| Input | Default | Description |\n|-------|---------|-------------|\n| `working_dir` | `\"./\"` | Directory inside the repo where Patcher runs (relative to repo root). |\n| `include_dirs` | `\"\"` | Report only: include dirs matching this double-star glob (e.g. `\"{*dev*}/**\"`). |\n| `exclude_dirs` | `\"\"` | Report only: exclude dirs matching this double-star glob. |\n| `update_strategy` | `\"next-breaking\"` | Patcher update strategy: `next-safe` or `next-breaking`. |\n| `spec_file` | `\"spec.json\"` | Filename for the upgrade spec (relative to repo root). |\n| `dependency` | `\"\"` | Optional: limit update to one dependency (e.g. `gruntwork-io/terraform-aws-security/github-actions-iam-role`). |\n| `pull_request_branch` | `\"patcher-updates\"` | Branch name for the PR (or `patcher-updates-\u003cdependency\u003e` when `dependency` is set). |\n| `skip_update` | `false` | If `true`, only run report and upload spec; do not run update or create a PR. |\n| `dry_run` | `false` | Simulate operations without making changes. |\n| `debug` | `false` | Enable Patcher debug logging. |\n\nThere are additional inputs for commit author, PR title, runner, Patcher/Terrapatch versions, and pipelines-credentials/actions repos and refs; see `.github/workflows/patcher.yml` for the full list.\n\n## Outputs\n\n- **`spec`** — The upgrade specification JSON produced by `patcher report` (multiline string).\n\n## Example workflows\n\nCopy and adapt the workflows under **`examples/github/workflows/`** into your repo’s `.github/workflows/`:\n\n| File | Purpose |\n|------|---------|\n| **`update-dev.yml`** | Update dev dependencies: manual, schedule (e.g. weekly), or `repository_dispatch`; uses `include_dirs: \"{*dev*}/**\"`. Can trigger the next env when a PR with label `updates-dev` is merged. |\n| **`update-stage.yml`** | Same pattern for stage; `include_dirs: \"{*stage*}/**\"`; triggered by `dev_updates_merged`. |\n| **`update-prod.yml`** | Same for prod; `include_dirs: \"{*prod*}/**\"`; triggered by `stage_updates_merged`. |\n| **`patcher.yml`** | Manual-only (“Run workflow”) with inputs for `include_dirs`, `exclude_dirs`, `update_strategy`, `dry_run`, `skip_update`, etc., for ad‑hoc and testing. |\n| **`patcher-readme-check.yml`** | Fails the PR if any `README-TO-COMPLETE-UPDATE.md` remain. |\n| **`label.yml`** | Labels PRs by changed folders (e.g. `updates-dev`, `updates-stage`). |\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgruntwork-io%2Fpatcher-action","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fgruntwork-io%2Fpatcher-action","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgruntwork-io%2Fpatcher-action/lists"}