README.md

ShellChecker

Description

GitHub action to execute a lint check of all shell scripts using ShellCheck.

It works under Ubuntu, macOS and Windows runners.

Usage example

_{.github/workflows/code-linting.yml :}

---
name: "Code linting"
permissions: {}
on: [push, pull_request, workflow_dispatch]

jobs:
  shellchecker:
    name: "ShellChecker"
    runs-on: ubuntu-latest
    permissions: {}

    steps:
      - name: "Check out code"
        uses: actions/checkout@v3
      - name: "ShellChecker"
        uses: a5k-actions/shellchecker@v0

Inputs

parameter	description	required	default
shellcheck-version	Version of ShellCheck to use. Values: [stable, latest, v0.8.0, ...]	false	stable
severity	Minimum severity of issues to display. Values: [style, info, warning, error]	false
enable-all-opt-checks	Enable all optional checks. Values: [true, false]	false	false
ignore-files	List of files to ignore, the separator is: |	false	gradlew

Outputs

parameter	description
NumFilesWthIssues	Number of files with issues
ListFilesWithIssues	A list of files with issues

Runs

This action is an composite action.