https://github.com/eslint/github-action
A GitHub action to run ESLint on pull requests
https://github.com/eslint/github-action
Last synced: 3 months ago
JSON representation
A GitHub action to run ESLint on pull requests
- Host: GitHub
- URL: https://github.com/eslint/github-action
- Owner: eslint
- License: apache-2.0
- Archived: true
- Created: 2019-09-20T17:37:47.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2019-10-18T16:28:36.000Z (about 6 years ago)
- Last Synced: 2024-04-14T07:42:43.689Z (over 1 year ago)
- Language: JavaScript
- Size: 946 KB
- Stars: 5
- Watchers: 13
- Forks: 8
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# Deprecated: ESLint GitHub Action
The GitHub-created `actions/setup-node` already supports annotating ESLint errors on commits and pull requests. Please use that instead.
### Prerequisites
In order to use this action, your project must have ESLint configured to run within your project. That means you must have a `package.json` file that specifies the version of `eslint` to use and any shareable configs that your project relies on.
## Configuring
First, create an npm script called `eslint:github-action` in your `package.json` file. This script should run ESLint on all of the files that should be linted on a pull request. Here's an example script:
```json
{
"scripts": {
"eslint:github-action": "eslint src/"
}
}
```
**Note:** Do not include the `-f` flag in your script. The ESLint GitHub Action relies on the default `stylish` ESLint formatter to find and annotate errors.
You can also add in any additional command line arguments to ESLint in the `eslint:github-action` script so that ESLint runs exactly the way you want it to.
Next, you'll need to create GitHub Actions workflow file to use this action, such as:
```yaml
name: Run ESLint on Pull Requests
on:
- pull_request
jobs:
build:
name: Run ESLint
runs-on: ubuntu-latest
steps:
# Check out the repository
- uses: actions/checkout@v1
# Install Node.js
- uses: actions/setup-node@v1
with:
node-version: 12
# Install your dependencies
- run: npm ci
# Run ESLint
- uses: eslint/github-action@v0
```
## Branches
* `master` - ongoing development. You should not use this branch in your GitHub workflows because it will not work (no dependencies checked in).
* `draft` - a draft of the next release. This may be unstable and also should not be used in your GitHub workflows. This branch is automatically created whenever code is committed to `master`.
## Frequently Asked Questions
### Why do I need to define a `eslint:github-action` npm script?
Different projects use ESLint in different ways, and it's not possible to come up with a single configuration that would work correctly for every project. You may be using certain command line flags, ignoring certain files, or using tools that call ESLint. The best way to know how your project uses ESLint is for you to tell us by creating a script that the GitHub Action uses.
### Why does the `eslint:github-action` npm script need to lint all of my files?
ESLint command line flags like `--ext` alter the files that ESLint lints. If you are using [eslint-plugin-markdown](https://npmjs.com/package/eslint-plugin-markdown), for example, then you might want ESLint to run on files ending with `.md`. Rather than trying to guess which files in a pull request might want linting applied, it's easier for you to create a script that does exactly what you want. The GitHub Action can then pull the appropriate information out of the results to report them.
### How does the GitHub Action work?
GitHub executes the `src/github-action.js` file. That file, in turn, calls `npx @eslint/github-action`, using the version number found in `package.json`, to execute the logic. By publishing the GitHub Action to npm and then running it with `npx`, we avoid the need to check dependencies into the repository.