https://github.com/neovici/github-actions-eslint-annotator

ESLint checker and annotator for Github Actions
https://github.com/neovici/github-actions-eslint-annotator

Last synced: about 1 year ago
JSON representation

ESLint checker and annotator for Github Actions

• Host: GitHub
• URL: https://github.com/neovici/github-actions-eslint-annotator
• Owner: Neovici
• License: apache-2.0
• Created: 2019-09-11T07:19:34.000Z (almost 7 years ago)
• Default Branch: master
• Last Pushed: 2022-06-25T08:21:12.000Z (almost 4 years ago)
• Last Synced: 2025-03-28T17:06:19.294Z (about 1 year ago)
• Language: JavaScript
• Size: 267 KB
• Stars: 7
• Watchers: 7
• Forks: 1
• Open Issues: 7
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# 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:

```yaml

    - 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](https://user-images.githubusercontent.com/960553/64773010-e5718480-d551-11e9-8bea-fd41d97d8aad.png)

## Credits

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