A GitHub Action that performs static analysis for shell scripts using ShellCheck.

Shell Linter can perform static analysis in various ways. You can use it to lint all the shell scripts in your project or lint a a specific file or folder using the path parameter. Specific use cases are shown below:

Run static analysis for all of the shell scripts.

jobs:
  lint:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v1
      - name: Lint check
        uses: azohra/shell-linter@v0.3.0

Run static analysis for a single shell script.

      - name: Lint check
        uses: azohra/shell-linter@v0.3.0
        with:
          path: "setup.sh"

Run static analysis for multiple shell scripts with or without extension.

      - name: Lint check
        uses: azohra/shell-linter@v0.3.0
        with:
          path: "setup,deploy.sh"

Run static analysis for all the shell scripts in a folder.

      - name: Lint check
        uses: azohra/shell-linter@v0.3.0
        with:
          path: "src"

Run static analysis using a wildcard path

      - name: Lint check
        uses: azohra/shell-linter@v0.3.0
        with:
          path: "src/*.sh"

Optional. Execute lint check on a specific file or folder. Default: .

This software is available as open source under the terms of the MIT License.