From bc6d3b47e257057587e29153947c1ba223160416 Mon Sep 17 00:00:00 2001
From: Burak Yigit Kaya <byk@sentry.io>
Date: Fri, 24 Jan 2020 21:08:41 +0300
Subject: [PATCH] feat(config): Have better GitHub config examples (#327)

Better defaults and guidance regarding GitHub app settings after getsentry/sentry#16550.
---
 sentry/config.example.yml     | 18 ++++++++++++++++++
 sentry/sentry.conf.example.py |  6 ++----
 2 files changed, 20 insertions(+), 4 deletions(-)

diff --git a/sentry/config.example.yml b/sentry/config.example.yml
index d31cf2e..ad237d9 100644
--- a/sentry/config.example.yml
+++ b/sentry/config.example.yml
@@ -71,3 +71,21 @@ symbolicator.options:
   url: "http://symbolicator:3021"
 
 transaction-events.force-disable-internal-project: true
+
+######################
+# GitHub Integration #
+######################
+
+# github-app.id: GITHUB_APP_ID
+# github-app.name: 'GITHUB_APP_NAME'
+# github-app.webhook-secret: 'GITHUB_WEBHOOK_SECRET' # Use only if configured in GitHub
+# github-app.client-id: 'GITHUB_CLIENT_ID'
+# github-app.client-secret: 'GITHUB_CLIENT_SECRET'
+# github-app.private-key: |
+#   -----BEGIN RSA PRIVATE KEY-----
+#   privatekeyprivatekeyprivatekeyprivatekey
+#   privatekeyprivatekeyprivatekeyprivatekey
+#   privatekeyprivatekeyprivatekeyprivatekey
+#   privatekeyprivatekeyprivatekeyprivatekey
+#   privatekeyprivatekeyprivatekeyprivatekey
+#   -----END RSA PRIVATE KEY-----
diff --git a/sentry/sentry.conf.example.py b/sentry/sentry.conf.example.py
index a11cb41..81dd29a 100644
--- a/sentry/sentry.conf.example.py
+++ b/sentry/sentry.conf.example.py
@@ -211,11 +211,9 @@ SENTRY_FEATURES.update(
 
 ######################
 # GitHub Integration #
-#####################
+######################
 
-# GITHUB_APP_ID = 'YOUR_GITHUB_APP_ID'
-# GITHUB_API_SECRET = 'YOUR_GITHUB_API_SECRET'
-# GITHUB_EXTENDED_PERMISSIONS = ['repo']
+GITHUB_EXTENDED_PERMISSIONS = ['repo']
 
 #########################
 # Bitbucket Integration #