Skip to content

Commit b560153

Browse files
authored
Add steps to get the installation id for a GitHub app (#1094)
* Add steps to get the installation id for a GitHub app * Add rationale for use
1 parent c69caef commit b560153

1 file changed

Lines changed: 16 additions & 1 deletion

File tree

  • website/docs/components/data-connectors

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

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

4040
#### GitHub App Installation
4141

42-
GitHub Apps provide a secure and scalable way to integrate with GitHub's API. [Learn more](https://docs.github.com/en/apps).
42+
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).
4343

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

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

5267
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)