GitHub

Overview

GitHub is an online software development platform used for storing, tracking, and collaborating on software projects. It is a cloud-based Git repository hosting service that makes it easier for individuals and teams to use Git for version control and collaboration.

The GitHub integration with Profit.co lets you track the status of GitHub issues and projects directly through Profit.co key results, keeping their progress updated as work moves forward in GitHub.

What This Integration Supports

With the GitHub integration, you can:

  • Track the status of GitHub issues and projects directly through Profit.co key results
  • Connect a key result to a GitHub query and pull its current value into Profit.co
  • Use Increase, Decrease, and Control KPI types for GitHub-linked key results
  • Automatically sync progress every day at 9 AM local time once a check-in is completed

Prerequisites

  • An active GitHub account with an access token generated for Profit.co
  • Permission to connect your GitHub account to Profit.co
  • Super User access in Profit.co

Configure GitHub in Profit.co

The following steps walk through generating a GitHub access token, connecting GitHub to Profit.co, and linking a key result to track its progress.

  1. Step 1

    Before connecting GitHub to Profit.co, generate an access token from your GitHub account.

    1. Log in to your GitHub account.
    1. Generate an access token to use for the Profit.co connection.
  2. Step 2

    Enable the GitHub connector from the Connectors page in Profit.co.

    1. Navigate to Settings from the left navigation panel.
    1. Click Integrations, go to the Connectors page, select the User Level tab, and click Manage next to GitHub.
    Step 2 screenshot
  3. Step 3

    Establish the connection between Profit.co and your GitHub account.

    1. Navigate to Preferences from the left navigation panel.
    1. Select the Integrations tab and click GitHub Manage.
    Step 3 screenshot 1
    1. On the Manage GitHub page, click the Connect to GitHub button.
    Step 3 screenshot 2
  4. Step 4

    Fill in the required credentials from your GitHub account to authenticate the connection.

    1. Enter the Connection Name.
    1. Select the Connection Type.
    1. Enter the Access Token.
    1. Select the Visibility.
    1. If Visibility is set to Access List, select the Employees or Departments who can access the connection.
    1. Select the Sync Frequency - Sync every day or Sync based on KR frequency.
    1. Click Connect to establish the connection.
    Step 4 screenshot 1
    Step 4 screenshot 2
  5. Step 5

    Create a key result in Profit.co and link it to GitHub to automate its progress tracking.

    1. Navigate to the OKR page in Profit.co.
    1. Create a new Key Result.
    1. Enter the Key Result Name and select one of the supported types: Increase KPI, Decrease KPI, or Control KPI.
    1. Select Automate Check-ins and choose GitHub from the Connection dropdown.
    Step 5 screenshot 1
    1. Enter your GitHub query and click Run.
    Step 5 screenshot 2

    Once the current value is pulled in from GitHub, complete the first check-in to activate progress tracking.

    Click Add, then click the check-in slider bubble to pull the value from GitHub.

    Step 5 screenshot 3
  6. Step 6

    1. Locate the Key Result and click Check-in.
    Step 6 screenshot 1
    Step 6 screenshot 2
    1. You will be redirected to the check-in review page with the GitHub value pre-filled.
    1. Click Checkin to record the progress and update the Key Result status.
    Step 6 screenshot 3
    Step 6 screenshot 4

Summary

By connecting GitHub to Profit.co, you can track the real-time progress of your GitHub issues and projects directly within your key results. After generating an access token and establishing the connection, linking a key result to a GitHub query keeps your OKRs current, with daily automated syncs ensuring progress stays up to date.

Note: Profit.co supports Increase, Decrease, and Control KPI types for the GitHub integration. Once the connection is established and a check-in is completed, progress syncs automatically every day at 9 AM local time.