Skip to content
You're viewing an older version of this GitHub Action. Do you want to see the latest version instead?
terminal

GitHub Action

ShellCheck

0.2.0

ShellCheck

terminal

ShellCheck

GitHub action for ShellCheck

Installation

Copy and paste the following snippet into your .yml file.

 
              
- name: ShellCheck

              
  uses: ludeeus/action-shellcheck@0.2.0
Learn more about this action in ludeeus/action-shellcheck

Choose a version

ShellCheck

GitHub action for ShellCheck.

Example

on: 
  push:
    branch:
      - master

name: 'Trigger: Push action'

jobs:
  shellcheck:
    name: Shellcheck
    runs-on: ubuntu-latest
    steps:
    - uses: actions/checkout@master
    - name: Run ShellCheck
      uses: ludeeus/action-shellcheck@master

Globally disable checks

To disable specific checks add it to a SHELLCHECK_OPTS env key in the job definition.

example:

    ...
    - name: Run ShellCheck
      uses: ludeeus/action-shellcheck@master
      env:
        SHELLCHECK_OPTS: -e SC2059 -e SC2034 -e SC1090

Ignore paths

You can use the ignore input to disable specific directories.

sample structure:
sample/directory/with/files/toignore/test.sh
sample/directory/with/files/test.sh

example:

    ...
    - name: Run ShellCheck
      uses: ludeeus/action-shellcheck@master
      with:
        ignore: toignore

This will skip sample/directory/with/files/toignore/test.sh