eslint-annotate-action
eslint-annotate-action copied to clipboard
ataylorme
A GitHub action that takes ESLint results from a JSON file and adds them as annotated pull request comments
ESLint Annotate from Report JSON
Version 2.0.0
Description
Analyzes an ESLint a report JSON file and posts the results.
On pull_request annotates the pull request diff with warnings and errors
On push creates a ESLint Report Analysis with a summary of errors and warnings, including links to the line numbers of the violations.
Why another ESLint action?
The others I tried to use ran ESLint in NodeJS themselves. With this action, I can take an ESLint report generated from the command line and process the results.
This allows for more flexibility on how ESLint is run. This action is agnostic enough to handle different configurations, extensions, etc. across projects without making assumptions on how ESLint should be run.
Inputs
| Name | Description | Required | Default Value |
|---|---|---|---|
repo-token |
The GITHUB_TOKEN secret |
Yes | N/A |
report-json |
The path to the ESLint report JSON file | No | eslint_report.json |
only-pr-files |
Only annotate files changed when run on the pull_request event |
No | true |
fail-on-warning |
Fail the GitHub Action when ESLint warnings are detected. Set to true to enable. |
No | false |
check-name |
The name of the GitHub status check created. | No | ESLint Report Analysis |
Usage Example
In .github/workflows/nodejs.yml:
name: Example NodeJS Workflow
on: [pull_request]
jobs:
node_test:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v2
- name: Setup Node
uses: actions/setup-node@v3
with:
node-version: 16
cache: 'npm'
- name: Install Node Dependencies
run: npm ci
env:
CI: TRUE
- name: Test Code Linting
run: npm run lint
- name: Save Code Linting Report JSON
# npm script for ESLint
# eslint --output-file eslint_report.json --format json src
# See https://eslint.org/docs/user-guide/command-line-interface#options
run: npm run lint:report
# Continue to the next step even if this fails
continue-on-error: true
- name: Annotate Code Linting Results
uses: ataylorme/eslint-annotate-action@v2
with:
repo-token: "${{ secrets.GITHUB_TOKEN }}"
report-json: "eslint_report.json"
- name: Upload ESLint report
uses: actions/upload-artifact@v2
with:
name: eslint_report.json
path: eslint_report.json
ataylorme