Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly
Sign up
Appearance settings

Commit 58f8aa9

Browse files
Merge pull request #244 from davidlabragaona-gk/SUP-4-github-app-integration-documentation-for-gij-cloud
initial github app for GIJ cloud. SUP-4
2 parents 0f0be31 + 9f9be95 commit 58f8aa9

9 files changed

+157
-0
lines changed

‎_images/gij-github-app-create-app.png

20 KB
Loading[フレーム]
29.9 KB
Loading[フレーム]

‎_images/gij-github-app-install-app.png

75.5 KB
Loading[フレーム]

‎_images/gij-github-app-int-setting.png

90.4 KB
Loading[フレーム]

‎_images/gij-github-app-integrations.png

127 KB
Loading[フレーム]
45.4 KB
Loading[フレーム]

‎_images/gij-github-app-select-repos.png

63.9 KB
Loading[フレーム]

‎_images/github-app-integration.png

23 KB
Loading[フレーム]
Lines changed: 157 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,157 @@
1+
---
2+
3+
title: GitHub App integration
4+
description:
5+
taxonomy:
6+
category: git-integration-for-jira-cloud
7+
8+
---
9+
10+
GitHub offers a variety of integration options, including: API, OAuth, and more recently GitHub Apps. There are a number of benefits to using GitHub app over OAuth:
11+
12+
* GitHub apps are by nature an organization installation. A separate GitHub account or service user is not required.
13+
14+
* Because GitHub apps require GitHub administrator authorization, we can rely on the GitHub app having administrator permissions.
15+
16+
* Determine repository access at the organization or repository level for the integration
17+
18+
* GitHub apps have a higher rate limit than OAuth.
19+
20+
For more details, see the [GitHub Apps article](https://docs.github.com/en/developers/apps/getting-started-with-apps/differences-between-github-apps-and-oauth-apps).
21+
22+
### New integration options
23+
24+
A new integration option is added into the Add integration Connect screen:
25+
26+
1. GitHub App (GitHub.com and GitHub Enterprise Cloud)
27+
28+
There are two terms:
29+
30+
* **GitHub Application (GHA)** – GHA itself is a set of authorization information. It is created in some GitHub organization during the first step of connecting a GHA integration with the Git Integration for Jira app.
31+
32+
* **Installation of a GitHub Application** – To get access to repositories inside the organization, an admin has to install the GHA in the organization. During the installation of GHA, the administrator selects the scope that will be available for this installation of this GHA. It is the second step of connecting a GHA integration.
33+
34+
 
35+
36+
### Permissions
37+
38+
<div class="bbb-callout bbb--alert">
39+
<div class="irow">
40+
<div class="ilogobox">
41+
<span class="logoimg"></span>
42+
</div>
43+
<div class="imsgbox">
44+
You must be a GitHub organization owner or have GitHub admin permissions in a repository to install/uninstall a GitHub App on that organization. If a GitHub App is installed in a repository and requires organization permissions, the GitHub organization owner must approve the application.
45+
</div>
46+
</div>
47+
</div>
48+
49+
Check GitHub Apps permission for your organization:
50+
51+
1. On your GitHub web portal, go to your organization ➜ **Settings** tab.
52+
53+
2. On the sidebar, click Developer settings ➜ **GitHub Apps**.
54+
55+
![](/wp-content/uploads/gij-github-app-org-setting-GHA-c.png)
56+
57+
&nbsp;
58+
59+
### Pre-requisites
60+
61+
<b style='background-color:#FFF1B6; padding:1px 5px; color:#172A4C; border-radius:3px; margin: 0 3px; font-size: small;padding:2px 7px'>IMPORTANT!</b>
62+
63+
* As an initial configuration requirement, admins need to install the GHA in an organization. After this setup, only then that Jira instance can read the repositories with Git Integration for Jira app.
64+
65+
&nbsp;
66+
67+
### Limitations
68+
69+
* If you remove the GitHub App integration from the Manage Integrations screen, remember that this does not remove the GitHub App from the GitHub Organization. Make sure you uninstall the corresponding GitHub App from the GitHub Organization after disconnecting the integration.
70+
71+
&nbsp;
72+
73+
### Integrate to a GitHub App
74+
75+
1. On your Jira dashboard menu, go to Apps ➜ **Git Integration for Jira by GitKraken**.
76+
77+
![](/wp-content/uploads/github-app-integration.png)
78+
79+
2. On the top right corner, click on the Add integration button. **GitHub**.
80+
81+
3. Click on the GitHub App option
82+
83+
![](/wp-content/uploads/gij-github-app-integrations.png)
84+
85+
4. Enter **Organization name**.
86+
87+
5. Click **Connect GitHub.com** to continue.
88+
89+
![](/wp-content/uploads/gij-github-app-create-app.png)
90+
91+
6. Click **Create GitHub App...** to proceed.
92+
93+
7. Choose:
94+
95+
* **All repositories** – to connect all repositories from this organization.
96+
97+
* **Only select repositories** – lets you select a specific repository for this setup.
98+
99+
![](/wp-content/uploads/gij-github-app-install-app.png)
100+
101+
8. Click **Install** to complete this process.
102+
103+
9. Select the repositories and click on **Connect repositories**
104+
105+
![](/wp-content/uploads/gij-github-app-select-repos.png)
106+
107+
10. On the *Configure Additional options* screen, change the configuration according your needs. You can change:
108+
109+
* Integration display name
110+
111+
* Require User PAT - If you will have users create branches and pull requests
112+
113+
* Indexing Triggers
114+
115+
* Project permissions
116+
117+
![](/wp-content/uploads/gij-github-app-int-setting.png)
118+
119+
11. Click on **Save options**
120+
121+
The GitHub App integration is now displayed in the Git repositories configuration list.
122+
123+
&nbsp;
124+
125+
### Post-install notes
126+
127+
The GitHub App is created automatically by the Git Integration for Jira app. For any related questions, please contact [gijsupport@gitkraken.com](mailto:gijsupport@gitkraken.com.)
128+
129+
* You can reconfigure connected repositories in the Edit integration settings page for this GitHub App integration.
130+
![](/wp-content/uploads/gij-github-app-edit-integration.png)
131+
132+
* Make sure that the following properties are not be changed for this GitHub App integration:
133+
* **GitHub App name**
134+
* Post installation
135+
* Webhook attributes
136+
* Private keys
137+
* Any settings on the Permissions and Events page
138+
* Any settings on the installation page
139+
140+
* Admins can restrict repositories using the JMESpath filter to avoid a case when a user tries to connect thousands of heavy repositories resulting in decreased Jira performance.
141+
142+
* A GitHub installation can be suspended in two ways:
143+
* **_From the owner side_** -- Press **Disconnect Integration** on the Integration Connection settings for the selected integration via Git Integration for Jira actions. <b style='background-color:#FFF1B6; padding:1px 5px; color:#172A4C; border-radius:3px; margin: 0 3px; font-size: small;padding:2px 7px'>RECOMMENDED</b>
144+
* **_From the user side_** -- Press **Suspend** on the GitHub portal for the GHA installation. <b style='background-color:#DEE0E5; padding:1px 5px; color:#44516C; border-radius:3px; margin: 0 3px; font-size: small;padding:2px 7px'>NOT RECOMMENDED</b>
145+
146+
* A GitHub App must be deleted by its owner. If several users have access to Repository Management, only one of them can actually remove the app from the Git server after the GitHub App integration is removed.
147+
148+
&nbsp;
149+
150+
[**Back to:** Integration basics](/git-integration-for-jira-cloud/introduction-to-git-integration-gij-cloud) (Git Integration for Jira Cloud)
151+
152+
---
153+
154+
### More Git Integration for Jira app features
155+
156+
See the [Features section](/git-integration-for-jira-cloud/features-gij-cloud) to learn more about Git Integration for Jira app features.
157+

0 commit comments

Comments
(0)

AltStyle によって変換されたページ (->オリジナル) /