Integrate GitHub with ClickUp to link ClickUp tasks with activity in GitHub.

The Workspace owner or admins can enable GitHub for the entire ClickUp Workspace, then members can connect their personal or organization repositories (repos) to specific Spaces. Tasks in Spaces with a connected repository (repo) can be linked with commits, branches, and PRs.

For example:

The engineering team for your mobile app and the website development team work in different repos and separate Spaces, within the same GitHub organization and ClickUp Workspace.

1. The Workspace owner enables the GitHub integration.
2. The mobile app manager connects the app-mobile GitHub repository (repo) to the Mobile App Dev Space.
3. The website manager connects the Website GitHub repo to the Marketing website Space.

Tasks in the Mobile App Dev and Marketing Website Spaces will display the GitHub icon, allowing both teams to link their tasks with GitHub commits, branches, and PRs.

What you'll need

• The GitHub integration is available on every ClickUp plan.
• Only Workspace owners and admins can set up integrations and link GitHub with Spaces.
• You'll need admin permissions to each repository to link them to a ClickUp Space.
• Workspace members can link their GitHub and ClickUp accounts to create new branches and pull requests from ClickUp.
• Guests can't use the GitHub integration.

Task view 3.0 is currently in beta. Join the 3.0 waitlist. The following instructions apply to both Task view 2.0 and Task view 3.0.

Set up the integration

There are four steps to set up the GitHub integration in ClickUp:

1. Authorize GitHub for your ClickUp Workspace.
2. Attach GitHub repositories to your Workspace.
3. Link GitHub repos to ClickUp Spaces.
4. Set your branch name format.

For example:

A ClickUp admin with admin permissions to the Website repo authorizes GitHub for the company's Workspace. They connect the Website repo to the Workspace and link it to the Marketing Website Space.

Another ClickUp admin with admin permissions to the app-mobile repo authorizes GitHub in the same Workspace. They connect the app-mobile repo to the Workspace and link it to the Mobile App Dev Space.

The marketing and engineering teams can connect their tasks and GitHub activity for their respective repos.

Authorize GitHub for your ClickUp Workspace

You'll need to be a Workspace owner or admin to authorize GitHub for your ClickUp Workspace.

There are two ways to authorize GitHub for your ClickUp account and Workspace.

From the App Center:

1. Use the Development category in the left sidebar or browse All Apps.
2. Select GitHub.
3. Click Manage.
4. Click Activate GitHub for Team.
5. Click + Add GitHub.
6. If you are logged out of GitHub, you'll be prompted to sign into GitHub.
7. Review the required permissions.
8. To add organization repositories, click Grant to allow ClickUp to organization access.
   
9. Click Authorize ClickUp.

Attach GitHub repositories to your Workspace

You can choose which GitHub repositories to link to your ClickUp Workspace. For example, you can link your personal repos with your personal Workspace, and your organization repos with your software team's Workspace.

Attaching a repository does not give ClickUp users access to your repository's codebase.

To add a repo to a Workspace:

From GitHub in the App Center:

1. Click Manage.
2. Under My repositories from GitHub, you'll see a list of repositories
3. Click + Add to ClickUp to add a repo to your Workspace.
4. Repeat for any other repos you want to add.

Not seeing the right repos? You may have signed in with the wrong GitHub account.

Make sure you're signed into GitHub with the account you want to use, and click Re-authenticate Github. Learn more about these options in our troubleshooting GitHub help article.

Link GitHub repos to ClickUp Spaces

Now that you've authorized GitHub and added repositories to your Workspace, you can add each repo to one or more Spaces. You can add or remove repos from Spaces at any time.

From GitHub in the App Center:

1. Click Manage.
2. Under the GitHub repositories added to ClickUp section, click the dropdown menu next to a repo.
3. Select one or more Spaces.
4. You can now link GitHub activity from that repo on tasks in the selected Space(s).
5. Repeat for any other repos you want to add to Spaces.

Set your branch name format

If your organization uses a specific format for branch names, you can set it on the Integrations page. When people create branches from ClickUp tasks, it will use this format.

The default format is: :taskId:_:taskName:_:username:

For example: CU-ae27de_Auto-generated-naming_John-smith

The available options are shown in the following table:

Value	Description
:username:	The user name of the ClickUp user account that created the branch. Spaces are replaced with a dash.
:taskId:	The ID of the ClickUp task where the branch is created. Includes the required prefix.
:taskName:	The name of the task where the branch is created. Spaces are replaced with a dash.

 

To set your default name format from GitHub in the App Center:

1. Click Manage.
2. Enter your preferred branch name format.
3. Click Save.

Link tasks from GitHub

ClickUp will automatically pick up new GitHub activity and associate it with tasks if you include a valid ClickUp task ID in any part of the pull request title, branch name, or commit message.

When linking tasks to a new pull request in GitHub, you'll see a comment confirming the task has been linked.

For personal repos, the comment will be posted using the repo owner's GitHub account. For organization repos, the comment will be posted using the GitHub account of the repo owner who added the repo to the ClickUp Workspace.

The task id must be formatted using one of these options:

#{task_id}

CU-{task_id}

{custom_task_id}

For example:

#1abc2de

CU-1abc2de

eng-123

Link tasks from ClickUp

You can also manually link ClickUp tasks with GitHub commits, branches, and pull requests from the ClickUp task.

1. Click the GitHub icon on any task.

2. Select the pull request, branch, or commit tab.

3. Select a repo, then choose a branch.

4. Link your pull request, branch, or commit to the ClickUp task.

5. In GitHub, ClickBot will post a comment confirming the task has been linked.

View GitHub activity in ClickUp

You can see all GitHub activity in a linked task's activity feed, along with task comments and other task updates.

When a branch is merged, commits display as a single activity item in the task or the task's activity feed. A link to all the commits opens a modal where you can click an individual commit to open it in GitHub.

GitHub task activity uses the person's ClickUp user name or their GitHub user name if they don't have a ClickUp account.

Update the task status from GitHub

You can update the status of a ClickUp task when you link or push a commit or when you create a pull request.

1. Add the ClickUp task ID in any part of the commit or pull request message.
2. Include the updated task status in square brackets.

For example: #ud5b[ready]

Watch the task's status change in this GIF.

Manage GitHub from ClickUp

You can manage GitHub from ClickUp tasks, including:

• Copy the ClickUp task ID with a valid prefix, for example: #1abc2de
• Copy a suggested branch name.
• Create and checkout a new branch.
• Copy a commit message to link tasks.
• Create a new branch.
• Create a pull request.

To manage GitHub from a task:

1. Click on the GitHub icon.
2. Use the options displayed on the left:
   • Click the copy button next to each option to copy the text to your clipboard.
   • Click Create branch or New Pull request.

Create and manage pull requests from ClickUp

To create a new pull request in ClickUp from tasks:

1. Click on the GitHub icon.

2. Click the New Pull Request button.

3. Select a target and source branch.

4. Enter a description.

5. Create the pull request.

6. In GitHub, ClickBot will post a comment to the pull request confirming the task has been linked.

Once a pull request is linked, you can see the following details from the ClickUp task:

• The person opened the pull request.
• Any assigned reviewers.
• CI/CD status.
• The pull request status including open, review requested, under review, merged, and closed.

Adding a GitHub account to ClickUp

Once a Workspace owner or admin has set up the integration, Workspace members can link their GitHub accounts to create branches and pull requests on tasks.

Workspace members (not guests) can add their GitHub account to their ClickUp account in advance or when they create a branch or pull request.

To connect or disconnect a GitHub account to a ClickUp account 

1. Click your account avatar.

2. Select My settings.

3. Click GitHub under My Apps in the sidebar.

4. To connect your GitHub account, click Connect and log in to GitHub.

5. To disconnect your GitHub account, click Disconnect.

   Disconnecting your Github account does not impact the integration between GitHub and the ClickUp Workspace.

Remove the GitHub integration

Only Workspace owners and admins can remove the GitHub integration from a Workspace.

To remove the GitHub integration from GitHub in the App Center:

1. Click Manage.
2. Click Remove GitHub.

Updated August 09, 2023 14:41