From fe05bbc9305bd5e7a752d5b08f39a892e33fe4fe Mon Sep 17 00:00:00 2001 From: ofer affias Date: Tue, 2 Jul 2024 14:54:22 +0300 Subject: [PATCH 1/2] moved tips --- docs/custom-github-app.md | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/docs/custom-github-app.md b/docs/custom-github-app.md index 96b7ba8d..8cbe23aa 100644 --- a/docs/custom-github-app.md +++ b/docs/custom-github-app.md @@ -76,15 +76,16 @@ We need the following permissions to enable all gitStream functionality: - **Read and write access to actions, checks, pull requests, and workflows:** Trigger workflows, create and update pull requests and their checks, and modify workflow files - **User email:** Used to identify users | +You need to enable these under the permissions section as shown below: + +![Permissions Setup 1](screenshots/create-new-github-app-setup-permissions-1.png) + !!! Tip Add the following Path (content paths to single files the app can access): 1. `.cm/gitstream.cm` 2. `github/workflows/gitstream.yml` -You need to enable these under the permissions section as shown below: - -![Permissions Setup 1](screenshots/create-new-github-app-setup-permissions-1.png) ![Permissions Setup 2](screenshots/create-new-github-app-setup-permissions-2.png) ![Permissions Setup 3](screenshots/create-new-github-app-setup-permissions-3.png) ![Permissions Setup 4](screenshots/create-new-github-app-setup-permissions-4.png) From 65183bba4255a009a4ce58c6f9756a6c36e95949 Mon Sep 17 00:00:00 2001 From: ofer affias Date: Tue, 2 Jul 2024 15:06:35 +0300 Subject: [PATCH 2/2] added min supported version --- docs/custom-github-app.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/docs/custom-github-app.md b/docs/custom-github-app.md index 8cbe23aa..e4693a8d 100644 --- a/docs/custom-github-app.md +++ b/docs/custom-github-app.md @@ -11,6 +11,10 @@ description: Install gitStream on Your GitHub Server. A GitHub application serves as the link between gitStream and GitHub. It facilitates user authentication via OAuth2 and allows users to select repositories accessible by gitStream. +!!! Info "Prerequisites" + + GitHub Server v3.10 or higher + In this section, we'll guide you through creating a GitHub app for your self-hosted gitStream installation. By the end, you should have noted down the following values: * App ID