https://github.com/pr-annotators/shellcheck-pr-annotator

Annotate pull requests with shellcheck errors detected during CI
https://github.com/pr-annotators/shellcheck-pr-annotator

annotations code-review github-actions pull-requests shell-scripts shellcheck

Last synced: 3 months ago
JSON representation

Annotate pull requests with shellcheck errors detected during CI

• Host: GitHub
• URL: https://github.com/pr-annotators/shellcheck-pr-annotator
• Owner: pr-annotators
• License: mit
• Created: 2022-03-31T17:54:58.000Z (over 3 years ago)
• Default Branch: main
• Last Pushed: 2022-03-31T18:12:43.000Z (over 3 years ago)
• Last Synced: 2025-03-04T09:02:13.074Z (4 months ago)
• Topics: annotations, code-review, github-actions, pull-requests, shell-scripts, shellcheck
• Homepage:
• Size: 1000 Bytes
• Stars: 2
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# 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

```yaml

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

```