This article provides instructions for connecting Github to your Akooda account. This connection essentially provides Akooda with access to either all or selected repositories and their respective branch interactions in your entire organization.
For more information about how Akooda helps your organization evolve and the inherent privacy and security protections in place, see Akooda Integration Principles.
NOTE: At the moment, Akooda is very-much branch-oriented and does not yet support additional organization information such as private/public Discussions and/or Projects. Moreover, keep in mind that only branches that have PRs will be pulled to the platform, work-in-progress cloud-backed branches are currently out of scope.
Before We Begin
Before connecting your organization’s Github account, check that:
You’re an Admin in Akooda.
You’re an Owner of your Github organization (see Github’s Roles in an organization article for more detail).
Your organization domain is verified (as instructed in Github’s Verifying or approving a domain for your organization guide).
NOTE: Unlike our other app integrations, the Akooda Github connector is linked to an organization and not a user within that account. Therefore, in order to unlink it the Owner of that organization must do that manually on the Github side. We highly recommend checking out Github’s Transferring organization ownership to ensure continuity in case Owner hand-off is required.
How to Connect
Link the Github User with Akooda
Sign into Akooda (app.akooda.co) with your admin user.
Navigate to the “Apps” page under the Account Settings (app.akooda.co/settings/apps)
Click on the “Connect” button for Github, which will open an app installation page.
Sign in to your organization’s workspace with the Github owner account, which will open a Github repository selection page.
Select the organization on which you want to install Akooda (your company’s Github organization, not your personal or other organizations you belong to).
Select either all repositories or a subset of them to be processed by Akooda.
Click “Install” to provide consent for Akooda to view the information needed to connect Github (as referenced in Github’s Permission Scopes guide)
NOTE: The permissions granted include seeing code, commits, issues, and pull requests. These are required for Akooda to be able to analyze users’ interactions on the selected repositories and their respective branches. Additionally, Akooda requires permissions to view organization metadata and administration information such as team members and their email addresses in order to map the user activity to the respective employee.
Following Akooda’s “Least-privilege Models” policy. The requested permissions do not include any write permissions.
Next Up
Processing your organization's data post initial integration may take up to 24 hours. Once done, you will be able to see tagged Github interaction data in your Akooda account (according to each individual user’s access permission).
If you run into any problems, we’re here to help. Reach out to [email protected] to get assistance for your organization.
Any Feedback?
Was this page helpful? Provide feedback on this article and ways we can improve to [email protected].