WorkSights connects to GitHub through a GitHub App installation. Once installed, GitHub delivers activity events directly to WorkSights using metadata only. Setup takes a few minutes and requires GitHub organization admin privileges.

For an overview of how GitHub activity appears in WorkSights, see GitHub Overview.

Connecting GitHub

Step 1: Start the Connection

1. Go to Services in the top navigation
2. Find GitHub in the list
3. Click Connect GitHub

Only Admins, Executives, and Owners in WorkSights can initiate the GitHub connection.

Step 2: Install the WorkSights App in GitHub

You will be redirected to GitHub to install the WorkSights GitHub App.

1. Choose the GitHub organization where you want to install the app
2. Select which repositories WorkSights should receive events from. You may grant access to specific repositories or to all repositories in the organization.

WorkSights does not request permission to read source code. GitHub sends WorkSights event notifications only for supported metadata activities.

Step 3: User Mapping

GitHub identifies people by GitHub username, not by email.

After installation, WorkSights cannot automatically match GitHub users to WorkSights profiles the way email-based integrations can.

1. Open the Users tab in the GitHub integration page
2. Map each GitHub username to the correct WorkSights user

This step is essential. Unmapped users will not have commits, pushes, pull request activity, or comments attributed to them in WorkSights. Pay particular attention to contractors and external contributors who may use unfamiliar GitHub handles.

What Happens Next

Once the GitHub App is installed and users are mapped, activity begins flowing immediately. Push events arrive in near real time, followed by the individual commits within them at their original timestamps. Pull request events, issue events, and code review activity appear as they occur.

Commit messages that include hashtag-style duration values (for example: #1h30m) allow WorkSights to associate a duration with that commit.

Related Guides

GitHub Overview

Commits

Pull Requests

Comments

Issues