Skip to content

Commit b4f214c

Browse files
fix(github): simplify repository setup and indexing outcomes (#7760)
* fix(github): simplify repository setup and indexing outcomes * fix(github): complete repository setup through one approval flow * fix(github): align shared setup test fixtures
1 parent 1be4328 commit b4f214c

122 files changed

Lines changed: 7118 additions & 833 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

apps/docs/content/docs/platform/self-hosting/integrations-oauth.mdx

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -142,14 +142,15 @@ Replace `<NEXT_PUBLIC_APP_URL>` with your configured public origin, such as `htt
142142
| Expire user authorization tokens | Enabled |
143143
| Request user authorization (OAuth) during installation | Disabled |
144144
| Enable Device Flow | Disabled |
145-
| Post installation → Setup URL | Empty |
145+
| Post installation → Setup URL | `<NEXT_PUBLIC_APP_URL>/api/knowledge/github/setup/callback` |
146+
| Post installation → Redirect on update | Enabled |
146147
| Webhook → Active | Disabled |
147148

148-
Authorization starts from Sim so the callback can finish the pending connection. The connector polls GitHub's API and does not need a webhook.
149+
Authorization starts from Sim so the callback can finish the pending connection. The **Setup URL** returns installation approval to that same setup attempt. Keep **Request user authorization (OAuth) during installation** disabled: Sim starts account authorization when it is needed, before installation. See GitHub's [Setup URL guide](https://docs.github.com/en/apps/creating-github-apps/registering-a-github-app/about-the-setup-url).
149150

150-
<Image className="mx-auto h-auto w-full max-w-md" src="/static/search/github-app-callback.jpg" alt="GitHub App registration with the Redirect URI, expiring tokens enabled, and installation authorization, Device Flow, and webhooks disabled" width={768} height={929} />
151+
For an existing deployment, deploy the application with the setup callback before changing the App registration. Use a separate GitHub App for each deployment origin, such as staging and production, so installation approval returns to the instance that started it. Keep the existing user authorization callback above unchanged.
151152

152-
*Example registration. Replace `sim.example.com` with your Sim domain.*
153+
The connector polls GitHub's API and does not need a webhook.
153154

154155
</Step>
155156
<Step>

apps/docs/content/docs/search/github.mdx

Lines changed: 43 additions & 27 deletions
Large diffs are not rendered by default.
-80.5 KB
Binary file not shown.
33.6 KB
Loading
-18.3 KB
Binary file not shown.
-13.5 KB
Binary file not shown.
31.1 KB
Loading
26 KB
Loading
46.4 KB
Loading
48 KB
Loading

0 commit comments

Comments
 (0)