Skip to content

Latest commit

 

History

History
28 lines (19 loc) · 799 Bytes

README.md

File metadata and controls

28 lines (19 loc) · 799 Bytes

github-actions-eslint-annotator

ESLint checker and annotator for Github Actions. Uses eslint, eslint CLI to run in a Github Actions environment and create a new Check for ESLint. If errors are found, these are annotated in the "Files Changed" tab.

Usage

In your project:

npm install --save-dev @neovici/github-actions-eslint-annotator

In your Github Actions workflow:

    - name: ESLint
      run: npx github-actions-eslint-annotator
      env:
        GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
        PARTIAL_LINTING: true # default: false, only works on PRs

Example output

Image of sample annotation

Credits

Based on https://github.com/gimenete/eslint-action