Merge pull request #56 from vitessio/update-readme

README.md

@@ -3,45 +3,21 @@
 This bot automates some tasks in the [`vitessio/vitess`](https://github.com/vitessio/vitess) git repo.
 
 It currently automates the following tasks:
-- [Adds a review checklist comment](https://github.com/vitessio/vitess-bot/blob/ae114aeffa7883916940bd9641b5e5602a1bae9b/index.js#L4-L26) on any Pull Request that is ready for review ([example comment](https://github.com/vitessio/vitess/pull/10847#issuecomment-1195644642))
+- Adds a review checklist comment on any Pull Request that is ready for review.
 - Adds the `NeedsWebsiteDocsUpdate`, `NeedsDescriptionUpdate`, and `NeedsIssue` labels to opened Pull Requests.
-- [Creates backports](https://github.com/vitessio/vitess-bot/blob/ae114aeffa7883916940bd9641b5e5602a1bae9b/index.js#L117-L160) against previous release branches for a Pull Request based on the original PR's [backport labels](https://github.com/vitessio/vitess/labels?q=backport)
-  - The portion of the label following the `Backport to: ` prefix must match the [git branch name](https://github.com/vitessio/vitess/branches/all?query=release-)
-  - This will fail if there are any conflicts or other issues which require manual intervention; a comment will be added to the original PR if this occurs ([example comment](https://github.com/vitessio/vitess/pull/10847#issuecomment-1200248322))
-- [Creates forwardports](https://github.com/vitessio/vitess-bot/blob/ae114aeffa7883916940bd9641b5e5602a1bae9b/index.js#L117-L160) against later release branches for a Pull Request based on the original PR's [forwardport labels](https://github.com/vitessio/vitess/labels?q=forwardport)
-  - The portion of the label following the `Forwardport to: ` prefix must match the [git branch name](https://github.com/vitessio/vitess/branches)
-  - This will fail if there are any conflicts or other issues which require manual intervention; a comment will be added to the original PR if this occurs ([example comment](https://github.com/vitessio/vitess/pull/10847#issuecomment-1200248322))
+- Creates backports and forwardports
+  - The suffix following the labels `Backport to: ` or `Forwardport to:` must match the [git branch name](https://github.com/vitessio/vitess/branches/all?query=release-)
+  - If there is conflict, the backport PR will be created as a draft and a comment will be added to ping the author of the original PR.
+- Automatic query serving error code documentation
 
 ## Installing the Bot
 You can install and configure the bot with the following commands:
 1. `git clone https://github.com/vitessio/vitess-bot.git`
 2. `cd vitess-bot/`
-3. `docker build -t vitess-bot .`
+3. `go build -o vitess-bot ./...`
+4. `./vitess-bot`
 
-## Running the Bot
-You can run the bot with the following command:
-`docker run -d --name vitess-bot -p 3000:3000 vitess-bot`
-
-## Running smee.io
-You must have a running instance of smee.io. It can be self-hosted or hosted on smee.io directly.
-You need to use the proper URL in your `.env` file to fetch data from the smee.io server.
-
-If you want to run smee.io locally, use the following command:
-`docker run -d -p 3001:3000 ghcr.io/probot/smee.io`
-
-The URL of your smee.io server will be `http://localhost:3001/channel`
-
-## Restarting the bot
-You may want to do this if, for instance, the bot is running but the events are not getting executed by the bot. You'll first want to stop and remove the old container:
-```
-docker container stop <name of the vitess bot container>
-docker container rm <name of the vitess bot container>
-```
-
-And then, start the container again:
-```
-docker run -d --name vitess-bot -p 3000:3000 vitess-bot
-```
+An example of how we run the bot in production is available in `.github/workflows/deploy.yml`.
 
 ## Notes
 :warning: When using [GitHub self-hosted runners](https://docs.github.com/en/actions/hosting-your-own-runners/about-self-hosted-runners), the bot should only be running on one of the runners at any given time.