Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore: complete the README #38

Merged
merged 5 commits into from
Jul 22, 2022
Merged

chore: complete the README #38

Changes from 2 commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
af45b08
chore: missing info
lemeurherve Jul 21, 2022
4589577
Update README.md
timja Jul 21, 2022
3d9f5c9
Update README.md
timja Jul 21, 2022
27291fc
Update README.md
timja Jul 21, 2022
94afd13
add deployment instruction to chart README
lemeurherveCB Jul 22, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 15 additions & 3 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,10 +7,11 @@ GitHub apps are used for authentication to limit the required permissions.

## Getting started

First you will need to create a GitHub app. Add the permissions required for the commands you are using.
Add a webhook to the app pointing at your endpoint, the path for the webhook receiver is `/api/github/webhooks`.
First you will need to create a GitHub app. Add the permissions required for the commands you are using (see next section), and tick "Subscribe to events" > "Issue comment"

This app is multiple organization aware and doesn't need any additional configuration to run in multiple organizations.
Add a webhook to the app pointing at your endpoint, the path for the webhook receiver is `<your-app-endpoint>/api/github/webhooks`.

This app is multiple organization aware and doesn't need any additional configuration to run in multiple organizations, you just need to install it on them.

_Note: You can't interact across organizations, like requesting reviews from teams in different organizations or transferring issues, this is a GitHub limitation._

Expand All @@ -22,6 +23,17 @@ Run `smee --path /api/github/webhooks` and point your webhook to the smee url th

The application runs on port 3000 by default, this can be customized with the `PORT` environment variable.

### Chart deployment

You can deploy this application in Kubernetes with the helm chart included in this repo:
timja marked this conversation as resolved.
Show resolved Hide resolved

```
helm repo add github-comment-ops https://timja.github.io/github-comment-ops
helm install github-comment-ops github-comment-ops/github-comment-ops
```

See more in the [chart README](charts/github-comment-ops)
timja marked this conversation as resolved.
Show resolved Hide resolved

### Required environment variables

- `GITHUB_APP_ID`
Expand Down