Home

Awesome

github-action-shellcheck

GitHub Actions for shellcheck

Run shellcheck and notify the result with reviewdog. This GitHub Actions does not install shellcheck and reviewdog, so you have to install them in advance. It allows to install tools outside this action. We recommend aqua to install them.

Motivation

We know there are other GitHub Actions for shellcheck. They install shellcheck automatically, but we would like to manage tools with aqua, which is a declarative CLI Version Manager written in Go. By aqua, you can update tools continuously with Renovate very easily and use the same tool versions in both CI and your development environment. This GitHub Actions does not install shellcheck, so we can install them outside this action.

Requirements

Example

- uses: suzuki-shunsuke/github-action-shellcheck@v0.1.1
- uses: suzuki-shunsuke/github-action-shellcheck@v0.1.1
  with:
    github_token: ${{ secrets.GITHUB_TOKEN }}
    working_directory: foo

Inputs

Required Inputs

Nothing.

Optional Inputs

namedefault valuedescription
github_tokengithub.tokenGitHub Access Token
working_directory"" (current directory)Woring Directory

Outputs

Nothing.

License

MIT