gha-validator

CLI tool to validate GitHub Actions workflows: outdated action versions, deprecated/unmaintained actions, unpinned mutable refs, missing permissions: blocks.

Install

pip install gha-validator

For unreleased changes on main, install from git instead:

pip install git+https://github.com/Al1084/GitHub-Actions-Validator.git@main

Usage

gha-validate .github/workflows/*.yml

SEVERITY  CHECK                    FILE    MESSAGE
--------  -----------------------  ------  ---------------------------------------------------------------------------------------------------------------------------
INFO      outdated-action-version  ci.yml  jobs.build.steps[0]: `actions/checkout@v3` is outdated (v7.0.1 available).
WARNING   unpinned-action          ci.yml  jobs.build.steps[1]: `actions/setup-node@main` is not pinned to a version or commit SHA.
INFO      outdated-action-version  ci.yml  jobs.build.steps[2]: `actions/create-release@v1` is outdated (v1.1.4 available).
WARNING   missing-permissions      ci.yml  Workflow does not declare a top-level `permissions` block.
WARNING   deprecated-action        ci.yml  jobs.build.steps[2]: `actions/create-release` is deprecated. Archived by GitHub; use `softprops/action-gh-release` instead.

Output format

--format table|json|github, default table.

gha-validate --format json .github/workflows/*.yml

[
  {
    "check": "outdated-action-version",
    "severity": "info",
    "message": "jobs.build.steps[0]: `actions/checkout@v3` is outdated (v7.0.1 available).",
    "file": "ci.yml",
    "line": 7,
    "fix": { "old": "actions/checkout@v3", "new": "actions/checkout@v7.0.1" }
  },
  {
    "check": "unpinned-action",
    "severity": "warning",
    "message": "jobs.build.steps[1]: `actions/setup-node@main` is not pinned to a version or commit SHA.",
    "file": "ci.yml",
    "line": 8,
    "fix": null
  }
]

--format github emits workflow-command annotations that GitHub renders as inline PR annotations:

gha-validate --format github .github/workflows/*.yml

::notice file=ci.yml,line=7::jobs.build.steps[0]: `actions/checkout@v3` is outdated (v7.0.1 available).
::warning file=ci.yml,line=8::jobs.build.steps[1]: `actions/setup-node@main` is not pinned to a version or commit SHA.
::notice file=ci.yml,line=9::jobs.build.steps[2]: `actions/create-release@v1` is outdated (v1.1.4 available).
::warning file=ci.yml::Workflow does not declare a top-level `permissions` block.
::warning file=ci.yml,line=9::jobs.build.steps[2]: `actions/create-release` is deprecated. Archived by GitHub; use `softprops/action-gh-release` instead.

Auto-fix

--fix auto-bumps outdated version pins in place. Only affects outdated-action-version findings, scoped to the exact flagged line (won't touch an identical string sitting in a comment or elsewhere in the file).

gha-validate --fix .github/workflows/*.yml

fixed ci.yml: actions/checkout@v3 -> actions/checkout@v7.0.1
fixed ci.yml: actions/create-release@v1 -> actions/create-release@v1.1.4

Exit code is non-zero if any error-severity finding remains.

As a GitHub Action

- uses: Al1084/GitHub-Actions-Validator@v0.1.1
  with:
    paths: .github/workflows/*.yml  # default
    format: github                  # default; table|json|github
    fix: "false"                    # default

No pip install step needed — the action installs itself from its own pinned ref.

Checks

• outdated-action-version — a pinned version tag has a newer release available
• unpinned-action — pinned to a mutable ref (@main, @master, a branch) instead of a version or commit SHA
• deprecated-action — action is archived/unmaintained (seed list, growing)
• missing-permissions — workflow has no top-level permissions: block