zbeekman / ShellCheck-Linter-Action

Deprecated, I suggest using this action instead:

Notice: This repository is deprecated. I recommend you use reviewdog/action-shellcheck instead.

ShellCheck-Linter-Action

     

A GitHub Action for linting your project's scripts with ShellCheck.

Table of Contents

Table of Contents

• ShellCheck-Linter-Action
  • Example Workflows
    • Check Conformance of Pushed Commits with ShellCheck
  • Future Plans
  • Other GitHub Action from @zbeekman

This project uses ShellCheck by Vidar Holen (@koalaman) to lint your project.

Example Workflows

Check Conformance of Pushed Commits with ShellCheck

To ensure your repository does not have any potential scripting errors, use the following workflow:

workflow "ShellCheck Audit" {
  on = "push"
  resolves = ["ShellCheck-Linter-Action"]
}

action "ShellCheck-Linter-Action" {
  uses = "zbeekman/ShellCheck-Linter-Action@v1.0.1"
  env = {
    ALWAYS_LINT_ALL_FILES = "true" # current default
  }
}

Currently, the ALWAYS_LINT_ALL_FILES variable is not implemented. Once it is it will defualt to false. When this is implemented, only files touched and still present in the pushed commit range will be checked. Once this is implemented, always lint all shell script files, set this to true. (This is the current behavior.) Depending on the size of the repository, this may take quite some time.

Future Plans

• Option to limit linting to changed script files
• Better integration with the GitHub checks API, maybe?

Other GitHub Action from @zbeekman

• EditorConfig-Action

---