Oobeya Docs
  • GETTING STARTED
    • Welcome to Oobeya!
    • Get Started with Oobeya
    • Playground: Live Demo
    • Oobeya Quick Onboarding Guide
  • TEAM INSIGHTS & SYMPTOMS
    • Symptoms Catalog
      • S1- Recurring high rework rate
      • S2- Recurring high cognitive load
      • S3- High weekend activity
      • S4 - High Code Review Time
      • S6- High technical debt on Sonar
      • S7- High vulnerabilities on Sonar
      • S8- High code quality bugs on Sonar
      • S9 - Unreviewed Pull Requests
      • S10 - Lightning Pull Requests
      • S11 - Oversize Pull Requests
      • S12- High Lead Time For Changes (DORA)
      • S13- Low Deployment Frequency (DORA)
      • S14- High Change Failure Rate (DORA)
  • SECURITY
    • 🔐Security at Oobeya
    • Oobeya Managed SaaS
  • INSTALLATION
    • 🐳Oobeya Docker Installation Tutorial & Requirements
    • 🐳Oobeya Version Upgrade For the docker-compose Installations
    • 🐳HTTPS Configuration For Docker Installations
  • PRODUCT DOCS
    • ⭐Oobeya Release Notes
      • 🎁Oobeya 2024 Q1 - Release Notes
      • 🎁Oobeya 2023 Q4 - Release Notes
      • 🎁Oobeya 2023 Q3 - Release Notes
      • 🎁Oobeya 2023 Q2 - Release Notes
      • 🎁Oobeya 2023 Q1 - Release Notes
      • 🎁Oobeya Nov & Dec '22 Updates
      • 🎁Oobeya September 2022 Updates
      • 🎁Oobeya August 2022 Updates
      • 🎁Oobeya July 2022 Updates
      • 🎁Oobeya June 2022 Updates
      • 🎁Oobeya Apr & May 2022 Updates
      • 🎁Oobeya March 2022 Updates
      • 🎁Oobeya Feb 2022 Updates
      • 🎁Oobeya Jan 2022 Updates
      • OOBEYA-2.0.8 - Release Notes
      • OOBEYA-2.0.4 - Release Notes
      • OOBEYA-2.0.0
      • OOBEYA-1.4.6
      • QAD-1.0 - 1.4
    • ▶️Product Tour
    • ❇️Metrics List
    • ☀️Developer Experience Metrics
  • INTEGRATIONS
    • Integration Catalog
      • SCM & CI/CD Integrations
        • Azure DevOps Integration
        • Bitbucket Cloud Integration
        • Bitbucket Server Integration
        • GitHub Integration
        • Step-by-Step Integration Instructions for the Oobeya GitHub Application
        • GitLab Integration
        • Jenkins & Cloudbees Integration
        • Octopus Deploy Integration
        • TeamCity Integration
      • Quality & Security Integrations
        • SonarQube Integration
        • SonarQube Cloud Integration
        • Veracode Integration
      • Project Management Integrations
        • Jira Cloud Integration
        • Jira Server Integration
      • APM / Monitoring Integrations
        • AppDynamics Integration
        • Azure Application Insights Integration
        • Dynatrace Integration
        • Elastic APM Integration
        • New Relic Integration
        • Sentry Integration
    • Installing An Addon
    • Adding A New Data Source
    • Updating and Deleting Data Sources
  • ADMINISTRATION
    • User Management, Single Sign-On, Auth Settings
      • Microsoft Entra (Azure AD) Integration
      • LDAP / Active Directory Integration
      • Importing a New User From LDAP / Active Directory
      • Bulk User Import in Oobeya Using CSV
      • Adding a New User
      • Deactivating a User
      • Understanding Roles in Oobeya
    • License Management
      • Updating The License Key
  • DEVELOPMENT ANALYTICS - GITWISER
    • Git Analytics - Metric Definitions
      • Coding Impact Score
      • Impact Ratio (team-level)
    • Setting Up Development Analytics And DORA Metrics
    • Git Analytics Exclusions
    • Setting Automated Reanalyze For Gitwiser
    • Deployment Analytics (DORA Metrics)
    • Merging Contributor Accounts
  • DORA Metrics
    • DORA Metrics Introduction
      • Lead Time For Changes (LTC)
      • Deployment Frequency (DF)
      • Change Failure Rate (CFR)
      • Mean Time To Restore Service (MTTR)
    • Failure Detection (For Change Failure Rate & MTTR)
    • How To Calculate DORA Metrics for GitHub
    • Updating Team Scorecard configuration to display DORA Metrics
    • How To Start Deployment Analytics (DORA Metrics) For An Existing Gitwiser Analysis
  • Project Analytics - AgileSpace
    • Agile Analytics - Metric Definitions
    • Agile Board Analytics Intro
    • Starting an Agile Board Analytics
    • Board Overview
    • Sprint Reports
    • Update the Agile Board Analytics
  • QUALITY ANALYTICS
    • Total Code Quality Index (TCQI)
  • Guides
    • Azure DevOps Guides
      • How To Calculate DORA Metrics for Azure DevOps
      • Best practices for integrating Oobeya with Azure DevOps Scrum Boards
  • PROFILES
    • Introduction
    • Adding A Profile
    • Developer Scorecard
    • Adding A Related Account Information To Oobeya Profile
  • Team Health
    • Adding A Team
    • Team Scorecard
    • Project Analytics (Scrum Teams) Widget
  • Test Quality Report Widget
  • CUSTOM DASHBOARDS
    • Adding A New Dashboard
    • Adding A New Widget
    • Updating And Deleting Widgets
    • Adding Jira Sprint Progress Widget
    • Adding Jira Board Metrics Widget (Metrics With JQL)
  • SUPPORT
    • Support Request Workflow
    • Customer Success & Support Guide
Powered by GitBook
On this page
  • Option 1: Using the Official Oobeya GitHub App
  • Step 1: Install the Oobeya GitHub App
  • Step 2: Create a Data Source in Oobeya
  • Option 2: Registering Your Own GitHub Application
  • Step 1: Create a New GitHub App
  • Step 2: Integrate the GitHub App with Oobeya
  • Troubleshooting
  • What's Next? 🎯

Was this helpful?

  1. INTEGRATIONS
  2. Integration Catalog
  3. SCM & CI/CD Integrations

Step-by-Step Integration Instructions for the Oobeya GitHub Application

PreviousGitHub IntegrationNextGitLab Integration

Last updated 5 months ago

Was this helpful?

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.

  1. 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.

  2. 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.

  3. Option 3: Use a .


Option 1: Using the Official Oobeya GitHub App

Utilize theavailable on the GitHub Marketplace to seamlessly integrate 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 within Oobeya. This straightforward approach ensures smooth integration and access to . See the step-by-step integration guide below:

Step 1: Install the Oobeya GitHub App

  1. Go to the and install the application.

  2. You will be prompted to choose which repositories to integrate with Oobeya. You can select all repositories or choose specific ones.

  3. After selecting the repositories, grant the necessary permissions requested by Oobeya.

Step 2: Create a Data Source in Oobeya

  1. Navigate to the Oobeya Data Sources page. Look for the GitHub integration and select it.

  2. Enter the name of the data source.

  3. Click the "Request GitHub Permission" button.

  4. Grant the required permissions on the GitHub website. Then you'll be redirected to the Oobeya screen.

  5. Select the newly created data source from the list and click the "Test Connection" button to see if it works properly.


Option 2: Registering Your Own GitHub Application

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:

Step 1: Create a New GitHub App

  1. 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.

  2. On the left menu, click on "Developer settings".

  3. On the left menu, click on "GitHub Apps".

  4. Click on the "New GitHub App" button.

  5. Fill in the required fields (GitHub App name, Homepage URL, Callback URL) with your information.

  6. Click the "Save Changes" button to save your changes.

  7. 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.

Step 2: Integrate the GitHub App with Oobeya

  1. Navigate to the Oobeya Data Sources page. Look for the GitHub integration and select it.

  2. Enter the GitHub App Client ID and Client Secret of the newly registered GitHub application.

  3. Finally, click the "Request GitHub Permission" button to add the new data source.


Troubleshooting

  • 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.


What's Next? 🎯

When in Oobeya, select "Oobeya GitHub App" as the "version".

For the Callback URL field, enter the following URL: {OOBEYA_DOMAIN}/api/platform/datasources/github (e.g., ).

When for GitHub, select "GitHub Own GitHub App" as the "version".

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 and .

If you are not using Oobeya, feel free to to learn more about Oobeya GitHub integration and explore Oobeya's powerful DORA Metrics tool.

adding the data source
https://test.oobeya.io/api/platform/datasources/github
adding the data source
DORA metrics
pull request metrics
contact us
DORA Metrics Introduction
How To Calculate DORA Metrics for GitHub
Personal Access Token for the integration
official Oobeya GitHub App
Oobeya
creating a data source
Oobeya's features
Oobeya DORA Metrics GitHub App Marketplace page
Oobeya DORA Metrics GitHub Application
Select Oobeya GitHub App
Test Connection
Permissions for your own GitHub App
Create your own application on GitHub and register it to Oobeya
Page cover image