From af45b08df61b6d23c8f0c06b3e51611167a9ae8a Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Herv=C3=A9=20Le=20Meur?= <91831478+lemeurherve@users.noreply.github.com> Date: Thu, 21 Jul 2022 18:08:17 +0200 Subject: [PATCH 1/5] chore: missing info --- README.md | 18 +++++++++++++++--- 1 file changed, 15 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index e0fcbb7..c6a54b6 100644 --- a/README.md +++ b/README.md @@ -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 `/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._ @@ -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: + +``` +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: https://github.com/timja/github-comment-ops/tree/main/charts/github-comment-ops + ### Required environment variables - `GITHUB_APP_ID` From 45895773e5755eb6b9dd072d510d8c771eb154ac Mon Sep 17 00:00:00 2001 From: Tim Jacomb <21194782+timja@users.noreply.github.com> Date: Thu, 21 Jul 2022 20:20:23 +0100 Subject: [PATCH 2/5] Update README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index c6a54b6..e7d5bc4 100644 --- a/README.md +++ b/README.md @@ -32,7 +32,7 @@ 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: https://github.com/timja/github-comment-ops/tree/main/charts/github-comment-ops +See more in the [chart README](charts/github-comment-ops) ### Required environment variables From 3d9f5c98199082ad60e5a776f1c167ffdc784df3 Mon Sep 17 00:00:00 2001 From: Tim Jacomb <21194782+timja@users.noreply.github.com> Date: Thu, 21 Jul 2022 20:20:57 +0100 Subject: [PATCH 3/5] Update README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index e7d5bc4..e23aa8d 100644 --- a/README.md +++ b/README.md @@ -32,7 +32,7 @@ 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) +See more in the [chart README](charts/github-comment-ops/README.md) ### Required environment variables From 27291fc55187091751fe9b83a9c7521fe99c6111 Mon Sep 17 00:00:00 2001 From: Tim Jacomb <21194782+timja@users.noreply.github.com> Date: Thu, 21 Jul 2022 20:21:25 +0100 Subject: [PATCH 4/5] Update README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index e23aa8d..1781777 100644 --- a/README.md +++ b/README.md @@ -25,7 +25,7 @@ The application runs on port 3000 by default, this can be customized with the `P ### Chart deployment -You can deploy this application in Kubernetes with the helm chart included in this repo: +You can deploy this application to Kubernetes with the helm chart included in this repo: ``` helm repo add github-comment-ops https://timja.github.io/github-comment-ops From 94afd1331609c98938babcc2d3b8833dd6ca8534 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Herv=C3=A9=20Le=20Meur?= Date: Fri, 22 Jul 2022 16:41:05 +0200 Subject: [PATCH 5/5] add deployment instruction to chart README --- charts/github-comment-ops/README.md | 9 +++++++++ charts/github-comment-ops/README.md.gotmpl | 10 ++++++++++ 2 files changed, 19 insertions(+) diff --git a/charts/github-comment-ops/README.md b/charts/github-comment-ops/README.md index 23e9024..289b04e 100644 --- a/charts/github-comment-ops/README.md +++ b/charts/github-comment-ops/README.md @@ -4,6 +4,15 @@ A tool for managing GitHub issues and pull requests via comment-ops. It uses GitHub webhooks to scale across repositories without needing to add a GitHub action to each of them. +## Chart deployment + +You can deploy this application to Kubernetes with the helm chart included in this repo: + +``` +helm repo add github-comment-ops https://timja.github.io/github-comment-ops +helm install github-comment-ops github-comment-ops/github-comment-ops +``` + ## Example ```yaml diff --git a/charts/github-comment-ops/README.md.gotmpl b/charts/github-comment-ops/README.md.gotmpl index a6c0669..a255245 100644 --- a/charts/github-comment-ops/README.md.gotmpl +++ b/charts/github-comment-ops/README.md.gotmpl @@ -13,6 +13,16 @@ {{ template "chart.requirementsSection" . }} +## Chart deployment + +You can deploy this application to Kubernetes with the helm chart included in this repo: + +``` +helm repo add github-comment-ops https://timja.github.io/github-comment-ops +helm install github-comment-ops github-comment-ops/github-comment-ops +``` + + ## Example ```yaml