Skip to content
Last updated

GitHub Enterprise Server connection to Reunite

When you connect a GitHub Enterprise Server to Reunite, a GitHub App is created and its credentials (App ID, Client ID, Client secret, and Private key) are securely stored within Reunite. Reunite uses these stored credentials exclusively to make API calls to your GitHub Enterprise Server instance. No credentials are shared with external services or used for any purpose other than communicating with the specified GitHub Enterprise Server.

The following diagram illustrates the interaction flow:

GitHub Enterprise ServerReuniteGitHub Enterprise ServerReuniteAction requires access to GitHub Enterprise ServerRead repo content, create commits,update commit statuses, manage PR infoUserPerform action (connect repo / sync content / view PRs)1Load saved GitHub App credentials2Authenticate + make API calls using GitHub App credentials3Process request + return response4Present result in UI5User

The flow works as follows:

  1. User interacts with Reunite. A user performs an action in Reunite that requires access to the GitHub Enterprise Server, such as connecting a repository, syncing content, or viewing pull requests.
  2. Reunite authenticates with the GitHub Enterprise Server. Reunite uses the saved GitHub App credentials to authenticate and make API calls to the GitHub Enterprise Server. These API calls handle operations like reading repository content, creating commits, updating commit statuses, and managing pull request information.
  3. GitHub Enterprise Server responds. The GitHub Enterprise Server processes the request and returns the response to Reunite, which then presents the result to the user.

In addition to API-initiated communication, your GitHub Enterprise Server sends webhook events (such as push, pull request, create, and delete) to Reunite. These webhooks notify Reunite about changes in your repositories, triggering actions like preview deployments and content synchronization without requiring the user to manually refresh.

Resources