kokuwaio/shellcheck

By kokuwaio

•Updated 4 days ago

A WoodpeckerCI plugin for shellcheck to lint shell files.

Image

Integration & delivery

Developer tools

5.6K

Overview Tags

kokuwaio/shellcheck repository overview

⁠Shellcheck WoodpeckerCI Plugin

A WoodpeckerCI⁠ plugin for shellsheck⁠ to lint shell files.
Also usable with Gitlab, Github or locally, see examples for usage.

⁠Features

preconfigure Shellcheck parameters
searches for shell files recursive
runnable with local docker daemon

⁠Example

Woodpecker:

steps:
  shellcheck:
    depends_on: []
    image: kokuwaio/shellcheck:v0.11.0
    settings:
      shell: bash
      severity: error
    when:
      event: pull_request
      path: "**/*.sh"

Gitlab: (using script is needed because of https://gitlab.com/gitlab-org/gitlab/-/issues/19717⁠)

shellcheck:
  needs: []
  stage: lint
  image:
    name: kokuwaio/shellcheck:v0.11.0
    entrypoint: [""]
  script: [/usr/local/bin/entrypoint.sh]
  rules:
    - if: $CI_PIPELINE_SOURCE == "merge_request_event"
      changes: ["**/*.sh"]

CLI:

docker run --rm --volume=$(pwd):$(pwd):ro --workdir=$(pwd) kokuwaio/shellcheck --shell=bash --severity=error

⁠Settings

Settings Name	Environment	Default	Description
`shell`	PLUGIN_SHELL	`none`	Specify dialect (sh, bash, dash, ksh, busybox)
`severity`	PLUGIN_SEVERITY	`style`	Minimum severity⁠ of errors to consider (error, warning, info, style)
`include`	PLUGIN_INCLUDE	`none`	Consider only given types of warnings
`exclude`	PLUGIN_EXCLUDE	`none`	Exclude types of warnings
`color`	PLUGIN_COLOR	`always`	Use color (auto, always, never)
`format`	PLUGIN_FORMAT	`tty`	Output format (checkstyle, diff, gcc, json, json1, quiet, tty)