As easy as the following, and even the more advanced features are just a few extra lines.

name: "my-workflow"
on: [pull_request]

jobs:
  eslint:
    runs-on: ubuntu-latest
    steps:
    - uses: actions/checkout@v2
    - uses: bradennapier/[email protected]

• 🎉 Works on Forked PR's Securely! 🎉
• Inline Annotations of ESLint Warnings & Errors
• Customizable ESLint options
• Optional summary comments on each push to the PR
• Links to the rule documentation when available
• Annotation Summary Page
• Suggestions are printed when enabled (not yet provided as change suggestions)
• Button to run ESLint Fix [COMING SOON]
• More...

The summary comments have some redundancy when there are suggestions available. This will be improved.

The fix property is not yet setup but will come shortly. If fixes are available, it will render an action button to run the fix as well.

You provide configuration properties within your workflow by using the with property. See the Simple Workflow Example for an example of providing your github-token.

array types are expected to be comma-separated values

The official settings can always be seen by viewing the action.yml schema for the action.

GitHub Actions only have read permissions when a forked PR is opened. However, we can work around this by setting up a scheduled job in our workflow. This runs at your given interval and will automatically enable serialization of results as workflow artifacts when required. Since these will always run against our master branch, we can safely run our results without concern that the fork has modified the workflow in any way which may be malicious.

Each time the schedule job runs it will run through any new artifacts and update the PR with the results like normal. If a job hasn't been detected in the last 24 hours then the action will no longer save artifacts. This is so you do not needlessly use up your data storage.

Note that we delete the artifacts as soon as they have been processed so they will not use up your storage for very long.

You can optionally add additional optimization by also making sure to run this action on the [closed] event so that we can cleanup all the artifacts when this occurs.

The scheduler will not start running until you have pushed the workflow to your main branch (master). If it still does not run you can try pushing an empty commit, it seems that is sometimes required git commit --allow-empty -m 'redeploy schedule action'

name: "lint"
on: 
  # by adding a schedule task to this workflow we will automatically
  # begin serializing read-only runs and handling them. The cron job
  # below is set to run every 15 minutes, GitHub will ignore anything
  # under 10 minutes and run every 10 minutes anyway.
  schedule:
    - cron: '*/15 * * * *'
  pull_request:
    types:
      - opened
      - synchronize
      - closed
jobs:
  lint:
    runs-on: ubuntu-latest
    steps:
    - uses: actions/checkout@v2
    - uses: bradennapier/[email protected]

Below is a basic example which should get you going. You can view the action.yml to see what other properties are available for customization.

name: "my-workflow"
on: [pull_request]

jobs:
  eslint:
    runs-on: ubuntu-latest
    steps:
    - uses: actions/checkout@v2
    - uses: bradennapier/[email protected]

There may be times that you need to provide a NPM_TOKEN so that the action can install your private repos. You do this by adding the secret to your repo Settings -> Secrets then providing it as an environment variable to the action:

jobs:
  eslint:
    runs-on: ubuntu-latest
    steps:
    - uses: actions/checkout@v2
    - uses: bradennapier/[email protected]
      env:
        NPM_TOKEN: ${{secrets.NPM_TOKEN}}

jobs:
  eslint:
    runs-on: ubuntu-latest
    steps:
    - uses: actions/checkout@v2
    - uses: bradennapier/[email protected]
      env:
        NPM_TOKEN: ${{secrets.NPM_TOKEN}}
      with: 
        issueSummaryType: full
        reportIgnoredFiles: true

This action was adapted from other actions which didn't quite work for me but were close. So special thanks to them for helping me get here.

• https://github.com/marketplace/actions/eslint-annotate
• https://github.com/marketplace/actions/eslint-action