Add `actionlint` with `pre-commit`: a static checker for GitHub Actions workflow files
- Dominant language
- Java
- Stars
- 3.1k
- Forks
- 1.4k
- Avg merge
- 6d 19h
- Merged PRs (30d)
- 32
Description
[actionlint](https://github.com/rhysd/actionlint) is a static checker for GitHub Actions workflow files
Check out the actionlint playground:
https://rhysd.github.io/actionlint/
https://github.com/rhysd/actionlint/blob/v1.7.7/docs/usage.md#pre-commit
```
repos:
- repo: https://github.com/rhysd/actionlint
rev: v1.7.7
hooks:
- id: actionlint
```
So the hook will need to be added to the pre-commit config and then all the `actionlint` lint errors will need fixing
The next document describes all checks done by actionlint with example inputs, outputs, and playground links:
https://github.com/rhysd/actionlint/blob/v1.7.7/docs/checks.md
Contributor guide
Research direction
Start with the pre-commit configuration and the GitHub Actions workflow files. Read actionlint's usage and checks documentation, then run the checker to identify the existing lint errors. Done means the actionlint hook is configured and all reported workflow errors are fixed.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- github-actions
- Domain
- ci-cd, tooling
- Issue type
- Refactor
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100