Skip to content

Commit 7ec9f58

Browse files
authored
Fix GitHub App manual creation (#717)
* Fix GitHub App manual creation Moved Email addresses permission to Account Permissions section instead of Repo permissions; fixed incorrect formatting * Fix link in manual GitHub App creation * Update git-providers.md
1 parent 3397cc8 commit 7ec9f58

File tree

1 file changed

+27
-22
lines changed

1 file changed

+27
-22
lines changed

_docs/integrations/git-providers.md

Lines changed: 27 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -148,7 +148,11 @@ An alternative way to authenticate with Github is via the App mechanism.
148148

149149
### Codefresh Github App
150150

151-
> The Codefresh App has READ permissions to issues, metadata, and pull requests, and READ and WRITE permissions to code, commit statuses, and repository hooks. If you need additional permission for your integration, use the Manual Creation steps.
151+
> The Codefresh App has:
152+
> * READ permissions to issues, metadata, and pull requests
153+
> * READ and WRITE permissions to code, commit statuses, and repository hooks
154+
155+
> If you need additional permission for your integration, use the Manual Creation steps.
152156
153157
1. In the Codefresh UI, follow the steps to [add a new Git provider](#adding-more-git-providers-to-your-codefresh-account).
154158
1. From the list of Git providers, select **Codefresh Github App**.
@@ -160,39 +164,40 @@ An alternative way to authenticate with Github is via the App mechanism.
160164

161165
### Manual creation
162166

163-
1. Log in your GitHub account and visit [https://github.com/settings/apps](https://github.com/settings/apps){:target="\_blank"}.
167+
1. Log in to your GitHub account and visit [https://github.com/settings/apps](https://github.com/settings/apps){:target="\_blank"}.
164168
1. Click **New GitHub App**.
165169
1. Do the following in the New GitHub App screen:
166-
1. Give an arbitrary name to your app (e.g. codefresh-integration)
167-
1. Fill *Homepage URL* with `http://www.codefresh.io`
168-
1. Uncheck the *Active* checkbox under the Webhook section
169-
1. In the *Repository permissions* section give the minimum of
170-
* **Contents** - read
171-
* **Issues** - read
172-
* **Metadata** - read
173-
* **Pull requests** - read
174-
* **Webhooks** - read, write
175-
* **Commit statuses** - read, write
176-
* **Email addresses** - read
177-
1. Click the *Create GitHub app* button.
170+
1. Enter an arbitrary name for your app in **GitHub App name**. For example, `codefresh-integration`.
171+
1. In the **Homepage URL**, enter `http://www.codefresh.io`.
172+
1. In the Webhook section, clear the **Active** checkbox.
173+
1. In the **Repository Permissions** section, assign the following permissions:
174+
* **Contents**: Read
175+
* **Issues**: Read
176+
* **Metadata**: Read
177+
* **Pull requests**: Read
178+
* **Webhooks**: Read, write
179+
* **Commit statuses**: Read, write
180+
1. In the **Account Permissions** section, assign the Read permission to **Email addresses**.
181+
1. Click the **Create GitHub app**.
178182

179183
1. In the next screen, do the following:
180184
1. Note down the **App ID** number under the About section.
181-
1. Click **Generate a private key**, and save the file locally.
182-
1. Click the **Install App** item from the left sidebar menu, and then click **Install** next to your codefresh app.
185+
1. Click **Generate a private key**, and save the file locally.
186+
1. From the sidebar, click **Install App**, and then click **Install** next to your Codefresh app.
183187
1. Accept the permissions, and in the next screen, define the repositories that you need Codefresh to access.
184188
From the URL of the browser, note the ending number which is your installation ID.
185-
For example if the URL is `https://github.com/settings/installations/10042353` then your installation number is `10042353`.
186-
1. In the Codefresh UI, go to [Pipeline Integrations > Git](https://g.codefresh.io/account-admin/account-conf/integration/git){:target="\_blank"}.
189+
For example if the URL is `https://github.com/settings/installations/10042353`, then your installation number is `10042353`.
190+
1. In the Codefresh UI, in the toolbar, click the **Settings** icon.
191+
1. From the sidebar, select **Pipeline Integrations > Git**, and then click **Configure**.
187192
1. From the **Add Git Provider** dropdown, select **Github App**.
188193
For the required fields use:
189-
* **Installation ID** which you noted down in _step 5_.
190-
* **App ID**, which you noted down in _step 4_.
191-
* **Private key**, which is the content of the file your created in step 4, converted to base64.
194+
* **App ID**, which you noted down in _step 4.1_.
195+
* **Private key**, which is the content of the file you created in _step 4.2_, converted to base64.
196+
* **Installation ID** which you noted down in _step 6_.
192197
1. To verify your integration, click **Test connection**.
193198
1. To apply your changes, click **Save**.
194199

195-
>If enabled in your account you can setup [Pipeline definition restrictions]({{site.baseurl}}/docs/administration/account-user-management/access-control/#pipeline-definition-restrictions) by expanding the *YAML Options* segment.
200+
>If enabled in your account you can set up [Pipeline definition restrictions]({{site.baseurl}}/docs/administration/account-user-management/access-control/#pipeline-definition-restrictions) by expanding the *YAML Options* segment.
196201
197202
## GitLab
198203

0 commit comments

Comments
 (0)