Skip to main content

actionlint

note

This is BETA. The behavior of this tool might change.

Supported VersionLanguageWebsite
1.6.3Othershttps://github.com/rhysd/actionlint

actionlint is a static checker for GitHub Actions workflow files.

Getting Started

To start using actionlint, enable it in your repository settings.

Configuration

You can customize the analysis via sider.yml:

linter:
actionlint:
target:
- .github/workflows/one_workflow.yml
- .github/workflows/another_workflow.yml
ignore:
- "job .* needs job"
- "unknown Webhook event"
NameTypeDefault
root_dirstring-
targetstring, string[]-
ignorestring, string[]-

target

This option allows you to specify files to analyze via actionlint. Glob format is not available. If target is not specified, by default, all yaml files in the .github/workflows/ directory of the repository root are analyzed. If you specify multiple targets, configure as follows:

linter:
actionlint:
target:
- .github/workflows/one_workflow.yml
- .github/workflows/another_workflow.yml

ignore

This option allows you to ignore certain errors based on regular expression matching of the actionlint error messages. For sample error messages, see actionlint documentation.

To ignore multiple error patterns, configure as follows:

linter:
actionlint:
ignore:
- "job .* needs job"
- "unknown Webhook event"