Integrating GitHub with Shorter Loop for Two-Way Issue Sync

Prerequisite: Creating a GitHub Personal Access Token (Classic)#

Steps to Connect Shorter Loop and GitHub#

1

Connecting Shorter Loop to GitHub

Now that you have your Personal Access Token, you can connect your Shorter Loop workspace to GitHub.

1. Go to Shorter Loop Integrations:

In Shorter Loop, navigate to left menu.

Click on the Integrations tab.

2. Initiate GitHub Linking:

Locate the GitHub tile.

Click the Link to GitHub button.

3. Enter Connection Details:

A dialog box titled Link to GitHub will appear.

API Access Token: Paste the Personal Access Token you securely saved earlier into the top field.

Organization Name: Enter the exact name of your GitHub Organization (e.g., shorterloop).

If you are linking a personal repository that is not part of an organization, you will still need to enter the organization name the repository is under, which is typically your GitHub username for personal repos.

4. Complete the Link:

Click the Link button.

Confirmation: A successful link will replace the Link to GitHub button with Unlink from GitHub.

2

Configuring the Two-Way Sync for a Repository

After linking your accounts, you must select the specific GitHub repository and configure the work item mapping for the sync.

1. Select a Repository:

The page will now list all the repositories within the Organization you connected.

Click on the repository you wish to integrate (e.g., shorterloop/covation-labs-backend).

This starts a 3-step integration process.

2. Connecting with Shorter Loop

2.1. Link Issues to a Shorter Loop Team

This step connects the chosen GitHub repository to a specific team in your Shorter Loop workspace.

Link Issues from this GitHub project: Shows the selected repository (e.g., shorterloop/covation-labs-backend).

Link issues to Shorter Loop team:

Action: From the dropdown menu, select the corresponding Team in Shorter Loop that will manage the issues from this repository (e.g., Konva team one).

Click Continue.

2.2. Select Work Items to Sync

This step ensures only the relevant types of work items synchronize between the platforms. Shorter Loop uses a fixed hierarchy for product planning (Epic, Feature, User Story).

Select work items to sync: Map the work item types in Shorter Loop to the corresponding issue types in GitHub.

Shorter Loop Work Item	Action: Select GitHub Work Item
Epic	Select the corresponding GitHub Issue/Item type (e.g., Task)
Feature	Select the corresponding GitHub Issue/Item type (e.g., Feature)
User Story	Select the corresponding GitHub Issue/Item type (e.g., Bug)

Click Continue.

2.3. Map Fields for Data Consistency

This final step ensures that data in common fields is synchronized correctly and maintains consistency.

Map fields: Align the essential fields between Shorter Loop and GitHub.

Shorter Loop Field	GitHub Field Name
Summary	Title
Description	Body
Tags	Lables

Other fields like Status will automatically map based on the work item types selected in the previous step.

Action: Once all fields are mapped correctly, click the Complete Integration button.

Integration Complete!#

What Happens Next?#