Step-by-Step Integration Instructions for the Oobeya GitHub Application
Last updated
Last updated
There are three options to integrate Oobeya with GitHub. This guide will provide detailed instructions on how to integrate Oobeya with GitHub using Option 1 and Option 2.
Option 1: Use the Official Oobeya GitHub App from the GitHub Marketplace. This option provides a straightforward integration process by installing the official Oobeya GitHub App and selecting it when creating a data source in Oobeya.
Option 2: Register your own GitHub application. This option offers more flexibility and customization by allowing you to create your own GitHub App, and configure settings.
Option 3: Use a Personal Access Token for the integration.
Utilize the official Oobeya GitHub App available on the GitHub Marketplace to seamlessly integrate Oobeya with your GitHub repositories and workflows. Simply install the application from the GitHub App Marketplace, grant the necessary permissions, and select the Oobeya GitHub App option when creating a data source within Oobeya. This straightforward approach ensures smooth integration and access to Oobeya's features. See the step-by-step integration guide below:
Go to the Oobeya DORA Metrics GitHub App Marketplace page and install the application.
You will be prompted to choose which repositories to integrate with Oobeya. You can select all repositories or choose specific ones.
After selecting the repositories, grant the necessary permissions requested by Oobeya.
Navigate to the Oobeya Data Sources page. Look for the GitHub integration and select it.
When adding the data source in Oobeya, select "Oobeya GitHub App" as the "version".
Enter the name of the data source.
Click the "Request GitHub Permission" button.
Grant the required permissions on the GitHub website. Then you'll be redirected to the Oobeya screen.
Select the newly created data source from the list and click the "Test Connection" button to see if it works properly.
Register your own GitHub Application to integrate with Oobeya for more flexibility and customization. By creating your own GitHub App, you can tailor the integration to suit your specific requirements and preferences. Navigate to your GitHub account settings, register a new GitHub App, configure the required permissions, and specify the Client ID and Client Secret within the Oobeya data source settings. This option offers greater control over the integration process, allowing you to manage the connection between Oobeya and GitHub according to your needs. See the step-by-step integration guide below:
Navigate to the Settings page on GitHub.
To register an application for a personal account, click on the "Developer settings" tab.
To register an application for an Organization, go to the "Organizations" tab from the left menu, then click on the "Settings" button next to the organization name.
On the left menu, click on "Developer settings".
On the left menu, click on "GitHub Apps".
Click on the "New GitHub App" button.
Fill in the required fields (GitHub App name, Homepage URL, Callback URL) with your information.
For the Callback URL field, enter the following URL: {OOBEYA_DOMAIN}/api/platform/datasources/github (e.g., https://test.oobeya.io/api/platform/datasources/github).
Click the "Save Changes" button to save your changes.
Open the "Permissions & events" tab from the left menu and select the following permissions as "Read-only" for the Actions, Administration, Code, Deployments, Issues, Members, Metadata, Organization Administration, Organization Events, Organization Projects, and Pull Requests.
Navigate to the Oobeya Data Sources page. Look for the GitHub integration and select it.
When adding the data source for GitHub, select "GitHub Own GitHub App" as the "version".
Enter the GitHub App Client ID and Client Secret of the newly registered GitHub application.
Finally, click the "Request GitHub Permission" button to add the new data source.
If you encounter issues with the integration, check the permissions granted during the installation process. Ensure Oobeya has access to the necessary data.
Consult the Oobeya support documentation or contact the Oobeya support team or your assigned Customer Success Engineer for specific issues related to the Oobeya platform.
By following these instructions, you will be able to effortlessly integrate the Oobeya GitHub Application into your Oobeya account. This integration will greatly enhance your development workflow by providing you with valuable metrics and data, including DORA metrics and pull request metrics.
If you are not using Oobeya, feel free to contact us to learn more about Oobeya GitHub integration and explore Oobeya's powerful DORA Metrics tool.
