Connect with GitHub Enterprise

Connecting with GitHub Enterprise grants buddybuild access to your repository so that it can build your app when you push code to your repository. Connecting also grants buddybuild API access to manage webhooks for you, generate commit status, integrate with the GitHub issue tracker, enables the pull request flow, synchronizes access control for team management and more.

Each member of your team that uses buddybuild should go through this guide to connect with GitHub Enterprise. This is encouraged so that you can take advantage of team management features.

The full process to connect to a specific GitHub Enterprise instance only needs to be completed once. Afterwards, anyone connecting with the same GitHub Enterprise instance (by specifying the same hostname:port, in step #4) adopts the same connection configuration, and they can skip to the account authorization step.

Caution

Buddybuild rejects connecting to repositories via HTTPS that are provisioned with self-signed certificates.

Using a self-signed certificate could make it possible for someone to spoof your repository and inject malicious code into your builds.

Connection steps

  1. If you have not already done so, sign up for a buddybuild account.

  2. Visit this link: https://dashboard.buddybuild.com/apps/wizard/build/select-source

    The Where is your source code? screen is displayed:

    The Where is your source code? screen

  3. Click the GitHub Enterprise box. The Connect with GitHub Enterprise screen is displayed:

    The Connect with GitHub Enterprise screen

  4. Specify the hostname for your GitHub Enterprise instance. If your instance uses a non-default HTTPS port, include the port. For example ghe.mycompany.com:1234.

    Important

    Your GitHub Enterprise instance needs to be publicly accessible. If necessary, adjust your firewall configuration to allow the buddybuild fleet of build servers to access your instance. See Self-hosted repositories for details.

    Also, if you use private DNS for your instance, use the IP address of the server instead of the hostname.

  5. The Continue button Click the Continue button. Two different screens could be displayed here:

    1. If this is the first time that this GitHub Enterprise instance is being connected, the Add buddybuild as an OAuth app screen is displayed:

      The Add buddybuild as an OAuth app screen

      If you see this screen, continue with step #6.

    2. If the GitHub Enterprise instance has been previously connected to buddybuild, the already configured screen is displayed:

      The Your GitHub Enterprise instance is already configured! screen

      If you see this screen, continue with step #26.

  6. The copy to clipboard button Click the copy to clipboard button beside the Callback URL field.

  7. In another browser window or tab, log in to your GitHub Enterprise instance.

    GitHub Enterprise, just after login.

  8. The GitHub Enterprise avatar dropdown menu At the top-right of the screen, click your account avatar. The avatar dropdown menu is displayed.

  9. Select Settings. The Public profile screen is displayed:

    The GitHub Enterprise Public profile screen

  10. The Organization settings panel in GitHub Enterprise At the bottom left of the screen, click the name of the organization that contains one or more repos that buddybuild should access. The Organization profile screen for the selected organization is displayed:

    The Organization profile screen in GitHub Enterprise

  11. The OAuth applications button in GitHub Enterprise In the left navigation bar, click the OAuth applications button. The OAuth applications screen is displayed:

    The OAuth applications screen in GitHub Enterprise

  12. The Register an application button in GitHub Enterprise Click the Register an application button. The Register a new OAuth application screen is displayed:

    The Register a new OAuth application screen in GitHub Enterprise

  13. In the Application name field, specify a name for the application. We recommend buddybuild.

  14. Optionally, fill in the Homepage URL field. If you do so, we recommend https://www.buddybuild.com/.

  15. Optionally, fill in the Application description field. If you do so, we recommend The CI/CD solution for mobile developers.

  16. Paste the Callback URL (that you copied from the Add buddybuild as an OAuth app screen) into the Authorization callback URL field.

  17. The Register application button on GitHub Enterprise Click the Register application button. The OAuth application details screen is displayed:

    The details page for the OAuth app in GitHub Enterprise

  18. Copy the Client ID value.

  19. Switch to the browser window or tab containing the buddybuild Add buddybuild as an OAuth app screen.

  20. Paste the Client ID value into the Enter your Client ID field.

  21. Switch to the browser window or tab containing the GitHub Enterprise screen.

  22. Copy the Client Secret value.

  23. Switch to the browser window or tab containing the buddybuild Add buddybuild as an OAuth app screen.

  24. Paste the Client Secret value into the Enter your Client secret field.

  25. The Continue button Click the Continue button. If the connection succeeds, a success screen is displayed:

    The connection success screen

    At this point, buddybuild can connect to your GitHub Enterprise instance, but it is not yet authorized to perform any actions.

  26. The Authorize your GitHub Enterprise account button Click the Authorize your GitHub Enterprise account button. The GitHub Enterprise authorization screen is displayed:

    The GitHub Enterprise authorization screen

  27. The Authorize <organization> button Click the Authorize button (in this example, Authorize test).

That’s it! You have now successfully connected buddybuild to your GitHub Enterprise instance.

The next step is to select a repository to build with buddybuild!

results matching ""

    No results matching ""