Skip to content

Commit 24350d7

Browse files
Merge branch 'trunk' into release/1.5.2
2 parents cddf243 + b560153 commit 24350d7

2 files changed

Lines changed: 27 additions & 2 deletions

File tree

website/blog/authors.yml

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -88,4 +88,14 @@ break-the-build:
8888
socials:
8989
github: break-the-build
9090
x: break_the_build
91-
linkedin: dan-luedke
91+
linkedin: dan-luedke
92+
93+
kevinzimmerman:
94+
name: Kevin Zimmerman
95+
title: Principal Software Engineer at Spice AI
96+
url: https://github.com/kczimm
97+
image_url: https://github.com/kczimm.png
98+
page: true
99+
socials:
100+
github: kczimm
101+
linkedin: kevinczimmerman

website/docs/components/data-connectors/github.md

Lines changed: 16 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -38,14 +38,29 @@ The dataset name. This will be used as the table name within Spice. The dataset
3838

3939
#### GitHub App Installation
4040

41-
GitHub Apps provide a secure and scalable way to integrate with GitHub's API. [Learn more](https://docs.github.com/en/apps).
41+
GitHub Apps provide a secure and scalable way to integrate with GitHub's API, and works well when interacting with one or more GitHub organizations. [Learn more](https://docs.github.com/en/apps).
4242

4343
| Parameter Name | Description |
4444
| ------------------------ | ------------------------------------------------------------------------------ |
4545
| `github_client_id` | Required. Specifies the client ID for GitHub App Installation auth mode. |
4646
| `github_private_key` | Required. Specifies the private key for GitHub App Installation auth mode. |
4747
| `github_installation_id` | Required. Specifies the installation ID for GitHub App Installation auth mode. |
4848

49+
The client ID and private key are generated when creating the GitHub app.
50+
51+
**Getting the Installation ID**
52+
53+
If the app is installed on a GitHub organization:
54+
- Visit the settings page for the organization (`https://github.com/organizations/<ORG>/settings/installations`)
55+
- Click "Configure" on the app
56+
- The URL of the page will be of the form `https://github.com/organizations/<ORG>/settings/installations/<INSTALLATION_ID>`
57+
58+
If the app is installed on a GitHub user:
59+
- Visit [the settings page](https://github.com/settings/installations)
60+
- Click "Configure" on the app
61+
- The URL of the page will be of the form `https://github.com/settings/installations/<INSTALLATION_ID>`
62+
63+
4964
:::note[Limitations]
5065

5166
With GitHub App Installation authentication, the connector's functionality depends on the permissions and scope of the GitHub App. Ensure that the app is installed on the repositories and configured with content, commits, issues and pull permissions to allow the corresponding datasets to work.

0 commit comments

Comments
 (0)