ylabonte/github-actions-updater
Scan .github/workflows for outdated remote action references; optionally apply updates and produce a non-interactive commit.
View on GitHubTrust Signals
- Scorecard Score
- not yet scored
- Maintenance Recency
- Stale
- License
- None
Inputs
| name | description | required | default |
|---|---|---|---|
| version | npm tag or version of github-actions-updater to run via `npx`. Defaults to `1`, matching the action major; override to pin tighter or to float across majors. | no | 1 |
| target | Update target policy: `latest`, `major`, `minor`, `patch`, `greatest`. When empty (the default) the CLI uses its own default (`latest`) unless a repo config file overrides it. | no | "" |
| filter | Space-separated globs of action names to include (e.g. "actions/*"). | no | "" |
| reject | Space-separated globs of action names to exclude (e.g. "docker://**"). | no | "" |
| workflows | Workflows directory to scan. When empty (the default) the CLI uses its own default (`.github/workflows`) unless a repo config file sets `workflowsDir`; set explicitly to force a value over any config (e.g. for a monorepo subpackage root). | no | "" |
| write | Apply updates to workflow files (--write). | no | false |
| commit | After --write, stage the rewritten workflow files and produce a non-interactive commit — no editor is invoked, the prefilled message is committed verbatim. Has no effect when write is false. | no | false |
| allow-branch-pin | On --write, convert branch refs to pinned SHAs. Tri-state: empty (default) defers to repo config or CLI default (`false`); `true` forces the conversion; `false` forces no-conversion even if a config file enables it. Note: `false` requires github-actions-updater >= 1.1.0 (it forwards `--no-allow-branch-pin` to the CLI). Pinning `version` to a 1.0.x CLI with `false` is treated as a no-op + warning, preserving the pre-1.1 behavior where the default already was no-conversion. | no | "" |
| fail-on-outdated | Exit non-zero when outdated entries are found. Tri-state: empty (default) defers to repo config or CLI default (`false`); `true` enables the CI gate; `false` forces drift-tolerance even if a config file enables the gate. Note: `false` requires github-actions-updater >= 1.1.0 (it forwards `--no-fail-on-outdated` to the CLI). Pinning `version` to a 1.0.x CLI with `false` is treated as a no-op + warning, preserving the pre-1.1 behavior where the default already was drift-tolerant. | no | "" |
| github-token | Token used for GitHub API auth. Defaults to the workflow-provided `github.token` when left empty. | no | "" |
Outputs
| name | description |
|---|---|
| outdated | Number of outdated references found. |
| changes | Number of workflow files actually rewritten by this run. Scoped to the `workflows` input (or `.github/workflows` if empty), so unrelated YAML edits elsewhere in the repo are not counted. Counted from the just-created commit when `commit: true`, otherwise from the working tree. Always `0` when `write: false` or outside a git repository. Known limitation: when `workflowsDir` is set ONLY in a repo config file (not also on the Action input), the count may under-report because the Action computes its diff scope from the input value only — pass the same path explicitly on the Action when relying on `changes` for gating. Proper fix queued for v1.2. |
| json | Path to the JSON report file the action produced. |