https://github.com/pollenjp/setup-shellcheck

https://github.com/pollenjp/setup-shellcheck

ci github-actions shell

Last synced: 2 months ago
JSON representation

• Host: GitHub
• URL: https://github.com/pollenjp/setup-shellcheck
• Owner: pollenjp
• License: other
• Created: 2024-11-25T01:55:55.000Z (over 1 year ago)
• Default Branch: main
• Last Pushed: 2025-03-10T19:11:26.000Z (over 1 year ago)
• Last Synced: 2025-03-27T22:59:39.543Z (over 1 year ago)
• Topics: ci, github-actions, shell
• Language: TypeScript
• Homepage: https://github.com/marketplace/actions/setup-shellcheck
• Size: 1.75 MB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 3
• Metadata Files:
  • Readme: README.md
  • License: LICENSE
  • Codeowners: CODEOWNERS

Awesome Lists containing this project

README

          
# setup-shellcheck

- Install [shellcheck](https://github.com/koalaman/shellcheck) and cache it for

  GitHub Actions

- Caching makes it especially efficient when using self-hosted runners

## Usage

```yaml

jobs:

  shellcheck:

    runs-on: ubuntu-latest

    steps:

      - uses: pollenjp/setup-shellcheck@v1

        with:

          version: latest

          # version: 0.10.0

      - uses: actions/checkout@v4

      - name: Run shellcheck

        run: shellcheck script.sh

```

If you use GitHub Enterprise Server, set the specific version (`X.Y.Z`), or set

`github-token` empty and `version: latest`.

```yaml

jobs:

  shellcheck:

    runs-on: ubuntu-latest

    steps:

      - uses: pollenjp/setup-shellcheck@v1

        with:

          version: 0.10.0

          #

          #or

          #

          # version: latest  # 'latest' requests GitHub API (github.com)

          # github-token: '' # Empty token may result in reaching the rate limit

          #                  # for anonymous requests

      - uses: actions/checkout@v4

      - name: Run shellcheck

        run: shellcheck script.sh

```