Text of pkg.go.dev › actionlint.kjanat.dev as Styx crawled it on Nov 20, 2026. The page may have changed since. Only its words are kept, without pictures or layout, and only the first part of a long page.

Open the live page

actionlint package - actionlint.kjanat.dev - Go Packages

README ¶ actionlint actionlint is a static checker for GitHub Actions workflow files. Try it online! This is an actively maintained fork of rhysd/actionlint . It carries the upstream checks plus cache safety policies enabled by default, configurable opt-in policy checks , composite action step validation, shell completion, and a first-party GitHub Action, and it ships attested binaries, a Docker image on GHCR and Docker Hub , and a Go module at actionlint.kjanat.dev .

Report problems through this fork's issue tracker . Features: Syntax check for workflow files to check unexpected or missing keys following workflow syntax Strong type check for ${{ }} expressions to catch several semantic errors like access to not existing property, type mismatches, ... Actions usage check to check that inputs at with: and outputs in steps.{id}.outputs are correct Reusable workflow check to check inputs/outputs/secrets of reusable workflows and workflow calls shellcheck and pyflakes integrations for scripts at run: Security checks ; script injection by untrusted inputs, hard-coded credentials Other several useful checks ; glob syntax validation, dependencies check for needs: , runner label validation, cron syntax validation, ...

See the full list of checks done by actionlint. Example of a broken workflow The same files the animation above records, run through both linters. This section is generated from them by scripts/check-readme , so it cannot drift. docs/screenshots/demo-workflow.yaml : name: Release on: push: branches: [main] jobs: build: strategy: matrix: node: ["20", "22"] runs-on: ubuntu-26.04 timeout-minutes: ${{ matrix.node }} steps: - uses: actions/checkout@v7 - run: npm run mock-api id: mock background: true - run: npm test - wait: api docs/screenshots/actionlint.yaml : # yaml-language-server: $schema=https://cdn.jsdelivr.net/npm/@kjanat/actionlint/actionlint.schema.json --- policy: require-commit-hash: true Upstream actionlint 1.7.12 reports 3: runner-label , syntax-check ×2 demo-workflow.yaml:10:14: label "ubuntu-26.04" is unknown. available labels are "windows-latest", "windows-latest-8-cores", "windows-2025", "windows-2025-vs2026", "windows-2022", "windows-11-arm", "ubuntu-slim", "ubuntu-latest", "ubuntu-latest-4-cores", "ubuntu-latest-8-cores", "ubuntu-latest-16-cores", "ubuntu-24.04", "ubuntu-24.04-arm", "ubuntu-22.04", "ubuntu-22.04-arm", "macos-latest", "macos-latest-xlarge", "macos-latest-large", "macos-26-intel", "macos-26-xlarge", "macos-26-large", "macos-26", "macos-15-intel", "macos-15-xlarge", "macos-15-large", "macos-15", "macos-14-xlarge", "macos-14-large", "macos-14", "self-hosted", "x64", "arm", "arm64", "linux", "macos", "windows". if it is a custom label for self-hosted runner, set list of labels in actionlint.yaml config file [runner-label] | 10 | runs-on: ubuntu-26.04 | ^~~~~~~~~~~~ demo-workflow.yaml:16:9: unexpected key "background" for step to run shell command. expected one of "continue-on-error", "env", "id", "if", "name", "run", "shell", "timeout-minutes", "working-directory" [syntax-check] | 16 | background: true | ^~~~~~~~~~~ demo-workflow.yaml:18:9: step must run script with "run" section or run action with "uses" section [syntax-check] | 18 | - wait: api | ^~~~~ This fork 1.16.1 reports 3: expression , require-commit-hash , parallel-steps demo-workflow.yaml:11:22: type of expression at "float number value" must be number but found type string [expression] | 11 | timeout-minutes: ${{ matrix.node }} | ^~~ demo-workflow.yaml:13:15: the ref "v7" of action "actions/checkout@v7" is not a commit SHA. actions must be pinned to a full-length commit SHA (40 or 64 hexadecimal digits) because "require-commit-hash" is enabled in the "policy" configuration. see https://docs.github.com/en/actions/security-for-github-actions/security-guides/security-hardening-for-github-actions#using-third-party-actions for more details [require-commit-hash] | 13 | - uses: actions/checkout@v7 | ^~~~~~~~~~~~~~~~~~~ demo-workflow.yaml:18:15: "api" is not the ID of a preceding background step.

"wait" and "cancel" steps can only refer to an earlier step that has "background: true" [parallel-steps] | 18 | - wait: api | ^~~ Quick start Install with npm , Homebrew , AUR , Scoop , or mise , or download a release archive . See the installation document for all options. To run it through npm: npx @kjanat/actionlint With a Go toolchain, install it from source: go install actionlint.kjanat.dev/cmd/actionlint@latest actionlint.kjanat.dev is a Go vanity import path .

The Go toolchain resolves it to this GitHub repository , where the source, releases, and issue tracker live. Further reading available here: GOPROXY protocol . Check for yourself: curl https://proxy.golang.org/actionlint.kjanat.dev/@latest Basically all you need to do is run the actionlint command in your repository. actionlint automatically detects workflows and checks errors. actionlint focuses on finding out mistakes.

It tries to catch errors as much as possible and make false positives as minimal as possible. actionlint Another option to try actionlint is the online playground . Your browser can run actionlint through WebAssembly. See the usage document for more details. GitHub Action This repository can be used directly as a Docker action. The prebuilt image includes actionlint, ShellCheck, and pyflakes, and reports problems as GitHub annotations by default.

Docker container actions run only on Linux, and this action also needs a reachable Docker daemon. ubuntu-slim is not supported: its job runs in an unprivileged container with the Docker client but no daemon or Docker socket. Standard Ubuntu runners, including ubuntu-24.04-arm and ubuntu-26.04-arm , are supported by the published linux/amd64 and linux/arm64 image. name: Lint GitHub Actions workflows on: [push, pull_request] jobs: actionlint: runs-on: ubuntu-latest steps: - { uses: actions/checkout@v7, with: { persist-credentials: false } } - uses: kjanat/actionlint@v1 On a daemon-less runner such as ubuntu-slim , download and run the binary instead: - uses: actions/checkout@v7 with: { persist-credentials: false } - name: Download and run actionlint env: { GH_TOKEN: "${{ github.token }}", GH_REPO: "kjanat/actionlint" } run: | case "${RUNNER_ARCH}" in X64) asset_arch=amd64 ;; ARM64) asset_arch=arm64 ;; ARM) asset_arch=armv6 ;; X86) asset_arch=386 ;; *) echo "Unsupported runner architecture: ${RUNNER_ARCH}" >&2; exit 1 ;; esac gh release download --pattern "actionlint_*_${RUNNER_OS,,}_${asset_arch}.tar.gz" --output - | tar -xzf - actionlint ./actionlint -color The moving v1 tag follows compatible v1 releases, and v1.16 follows v1.16 patch releases.

These tags point to a commit immediately after the release that pins the published container image by digest. v1.17.1 is a versioned release tag. For an immutable action reference with a pinned image, use the full commit SHA resolved from a floating tag. Inputs Input Default Description files all workflows Newline-separated workflow paths. Empty checks every workflow in the repository. format github Output format: github , default , oneline , json , json-lines , markdown , or sarif . ignore none Newline-separated regular expressions for actionlint errors to ignore. config-file automatic Configuration file path relative to working-directory . shellcheck true Run ShellCheck for shell scripts in workflow steps. pyflakes true Run pyflakes for Python scripts in workflow steps. working-directory .

Directory to lint, relative to the repository workspace. output-file none Repository-relative file to receive the selected output format. fail-on-error true Fail when problems are found. Invalid options and fatal errors always fail. Outputs Output Description exit-code actionlint exit code: 0 for clean, 1 for problems, 2 for invalid options, or 3 for failure. result success , problems-found , invalid-options , or failure . problems-found Whether actionlint found one or more problems. problem-count Number of problems, o

The rest of this page is on the live site.