4 CircleCI

Petra Jaros edited this page 2020-10-04 14:34:05 -04:00

Table of Contents

• Via CircleCI Orbs
• Manually

Shellcheck can be run on CircleCI in a variety of ways:

Via CircleCI Orbs

CircleCI provides a circleci/shellcheck orb that can be used in any CircleCI workflow:

https://circleci.com/orbs/registry/orb/circleci/shellcheck

version: 2.1

orbs:
  shellcheck: circleci/shellcheck@2.0.0

workflows:
  shellcheck:
    jobs:
      - shellcheck/check

Manually

Simply copy and paste the existing installation instructions into a run step in your CircleCI job.

For example:

version: 2.1

jobs:
  build:
    macos:
      xcode: "9.0"
    steps:
      - checkout
      - run: brew install shellcheck

Or, in a Linux-based image:

version: 2.1

jobs:
  build:
    machine: true
    steps:
      - checkout
      - run: apt-get install shellcheck

ShellCheck

• Installation

  • CentOS6
  • More Installation Guides

• Usage

  • Directive
  • Ignore

• Integrating and extending

  • Misc. contributions
  • Azure Pipelines
  • Buildkite
  • CircleCI
  • DevGuide
  • Integration
  • JUnit
  • Phabricator
  • TravisCI
  • GitLab CI
  • Drone
  • GitHub Actions

• Severity

• Template

Each individual ShellCheck warning has its own wiki page like SC1000. Use GitHub Wiki's "Pages" feature above to find a specific one, or see Checks.