Skip to content

Commit a8e1b08

Browse files
committed
Update README
1 parent a40e36d commit a8e1b08

File tree

1 file changed

+9
-22
lines changed

1 file changed

+9
-22
lines changed

README.md

Lines changed: 9 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -1,39 +1,22 @@
11
[![Build Status](https://github.com/eslint/eslint-github-bot/workflows/CI/badge.svg)](https://github.com/eslint/eslint-github-bot/actions)
22

3-
ESLint GitHub bot
4-
==========================
3+
# ESLint GitHub bot
54

65
`eslint-github-bot` is a bot created with [probot](https://github.com/probot/probot) which automates some common tasks for repositories run by the ESLint team.
76

8-
The bot can perform the following tasks:
9-
10-
* **Triage** - adds the "triage" label to newly-created issues which don't have labels.
11-
* **Commit message check** - adds a status check to pull requests to verify that they follow ESLint's [pull request guidelines](https://eslint.org/docs/developer-guide/contributing/pull-requests#step-2-make-your-changes)
12-
* **Needs info** - adds a comment to issues requesting more information when a maintainer adds the `needs info` label.
13-
* **Release/TSC meeting issues** - creates a new issue with the `release`/`tsc meeting` label scheduled two weeks later, after another release/TSC meeting issue is closed.
14-
* **Release monitor** - searches the repository for an issue with the `release` and `patch release pending` labels, indicating that a patch release might soon be created from `master`. If an issue is found, adds a pending status check to all PRs that would require a semver-minor release, to prevent anyone from accidentally merging them.
15-
* **Issue Archiver** - Locks and adds a label to issues which have been closed for a while
16-
* **Issue Closer** - Closes and adds a label to issues which have been inactive for a while
17-
* **WIP Tracking** - adds pending status check for PRs with WIP in the title or with "do not merge" label, and marks the status check as successful once the WIP indicators are removed.
18-
* **PR ready to merge** (experimental) - adds a label to all PRs which are "ready to merge", defined by the following criteria:
19-
* At least one review is approved.
20-
* Build status is `success`.
21-
* **Check unit tests** (experimental) - makes sure a PR contains unit tests. This check will be ignored for PRs with `Build|Chore|Docs|Upgrade` in the commit message.
22-
* **Duplicate comments** (inactive) - removes all the duplicates comments by this bot and leaves the last one of each type.
23-
247
## :wrench: Setup
258

269
* Clone this repo.
2710
* `npm install`
2811
* Start the app
29-
* `npm start` to start it as a GitHub APP
12+
* `npm start` to start it as a GitHub APP
3013

3114
### ENV variables required:
3215

3316
* `PORT`: Port for web server _(optional, defaults to 8000)_.
34-
* `SECRET`: Secret setup for GitHub webhook or you generated when you created the app.
17+
* `WEBHOOK_SECRET`: Secret setup for GitHub webhook or you generated when you created the app.
3518
* `PRIVATE_KEY`: the contents of the private key you downloaded after creating the app.
36-
* `APP_ID`: The numeric app ID
19+
* `APP_ID`: The numeric GitHub app ID
3720

3821
#### Adding plugins
3922

@@ -45,4 +28,8 @@ To add a plugin:
4528

4629
## Deployment
4730

48-
The bot is deployed to a [Dokku](https://dokku.com) instance named github-bot.eslint.org and is installed as a GitHub Application at the organization level.
31+
The bot is deployed to a [Dokku](https://dokku.com) instance named <https://github-bot.eslint.org> and is installed as a GitHub Application at the organization level.
32+
33+
### Health Check
34+
35+
<https://github-bot.eslint.org/ping>

0 commit comments

Comments
 (0)