Skip to content

README.md

Latest commit

 

History

History
29 lines (21 loc) · 637 Bytes

README.md

File metadata and controls

29 lines (21 loc) · 637 Bytes

Shellcheck PR Annotator

Usage

Annotate pull requests with shellcheck errors detected during CI.

This is designed to work with the "gcc" output format of shellcheck.

Note: This doesn't install or run shellcheck, it just sets up the PR annotations.

Example workflow

name: My Workflow
on: [push, pull_request]
jobs:
  build:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@master

      - name: Add shellcheck annotator
        uses: pr-annotators/shellcheck-pr-annotator@master

      - name: Run shellcheck
        uses: ludeeus/action-shellcheck@master
        with:
          format: gcc