GitHub Enterprise Apps docs #1211
Conversation
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
|
pjlast
changed the title
eseliger
left a comment
eseliger
left a comment
There was a problem hiding this comment.
Great thanks!
When merged can you get back on https://linear.app/sourcegraph/issue/SRC-1330/factset-slow-page-load and recommend this as our proposed fix for their page load time issues? 🙏
docs/admin/code_hosts/github.mdx
Outdated
| // To sync repositories from all installations of a GitHub App, omit the installationID field. | ||
| // To sync repositories from a specific installation only, include the installationID field. | ||
| "gitHubAppDetails": null, |
There was a problem hiding this comment.
this is the most useless piece of documentation btw 😆 the JSON schema renderer is so bad lol
There was a problem hiding this comment.
I know 😭 but it's where it would be :(
There was a problem hiding this comment.
But it looks bad idk I'll remove it
|
|
||
| There are two ways to connect a GitHub App: | ||
| 1. **[Create a new GitHub App](#creating-a-new-github-app)** via Sourcegraph, which will set up all of the required permissions and automatically retrieve the credentials | ||
| 2. **[Add an existing GitHub App](#adding-an-existing-github-app)** by providing the details of an existing GitHub App (required when using GitHub Enterprise Apps) |
There was a problem hiding this comment.
just wondering, is it theoretically possible to create a GHE App via the post method as well, we just don't support it right now?
Maybe we could look into that one day.
There was a problem hiding this comment.
Nothing in the docs makes me believe that it's not possible, but the one customer that tried it (that we know of, at least) could not get it to work
There was a problem hiding this comment.
we probably don't post the form to the right endpoint or so, the enterprise GH Apps page is in a completely different place 😬
There was a problem hiding this comment.
I'll have a look! Maybe we can fix that
| - **Client ID**: The unique identifier for your GitHub App | ||
| - **Private Key**: The private key generated for your GitHub App (in PEM format) | ||
| 4. Click **Add GitHub App** to save the configuration. | ||
| 5. Once added, you can manage installations and create code host connections just like with apps created through Sourcegraph. |
There was a problem hiding this comment.
do we need to call out here what we provision for GitHub Apps usually, so the webhook events, token scopes, etc are sufficient? Plus creating a client id/secret pair and adding it to auth.providers
pjlast
changed the title
pjlast
deleted the
petrilast-src-1267-feedback-on-github-apps-setup-for-multiple-organizations
branch
Adds some docs on how to use GitHub Enterprise Apps (i.e. add the GitHub App manually)
Also mention how to set up an app-wide code host connection