With ClickUp's GitHub integration, users can associate GitHub pull requests, branches, and commits with ClickUp tasks. This allows users to:
- See all GitHub activity related to a task directly in ClickUp.
- Automatically change Statuses with GitHub actions by adding
CU-1234[closed]to your commits
- Optionally receive ClickUp notifications when new GitHub activity items are added to tasks.
- Automatically (or manually) attach Github activity to ClickUp tasks.
How to Enable Github in ClickUp
Step 1: Authorize Github
Add GitHub to authorize ClickUp.
Note: To add organization repositories, you must check the box to allow ClickUp to access these repositories when authorizing. Here is what your settings page will look like with organization access enabled:
Step 2: Activate GitHub Integration
Click the big purple button to activate GitHub for your Workspace.
Step 3: Attach Personal Repositories to your Workspace
ClickUp allows multiple people to authorize GitHub within your Workspace, and also permits you to customize which repositories are shared with your Workspace.
This means that you can authorize your personal account without attaching all of your repositories; you can customize which ones to attach.
Attaching a repository does not give users access to your repository's codebase in any way. It simply allows users to attach history items for that repository to the Space(s) you specify.
Step 4: Select which Spaces are attached to your Repositories
You can customize which Spaces that repositories are attached to by expanding the drop-down on the right side . Select one or more Spaces to attach a repository.
In order to attach GitHub items to tasks, the Space must be attached to the repository.
Automatically Associating GitHub Activity in ClickUp
ClickUp will automatically pick up new activity and associate it with tasks.
To enable this, you must:
Add the ClickUp task ID in any part of the pull request title, branch name, or commit message with
CU- in front of it.
Manually Associating GitHub Activity
- Click the GitHub icon on any task
- Select the pull request, branch, or commit tab
- Select a repo then chose a branch
- Attach your pull request, branch, or commit
Automatically Change Task Status via GitHub
You can also change the status of a task from a
commit, issue, or merge request.
To do this:
Add the ClickUp task ID in any part of the commit message with
CU- in front of it, as well as the status you want inside brackets
Watch the task's status change in this video. Example: CU-ud5b[ready]
Quickly and easily create new branches from within ClickUp with our quick actions.
- Click on the GitHub icon to open the Git modal
- On the left-hand side are a variety of auto-generated quick copy options like suggested name, command to checkout and link a new branch locally, command to link a single commit, or a command to open a pull request
You can customize the auto-generated name used in these options under the GitHub integration settings!
Now, you can create pull requests from within ClickUp or link existing ones! To create a new pull request in ClickUp:
- Click on the Github icon on the task you would like to link it to and click the "New Pull Request" button.
- In the modal, a suggested pull request title will be pre-filled with a suggested title. If you don't like the auto generated title, you can adjust it in the GitHub integration settings. If changed, be sure to include the task id,
CU-taskid, somewhere in the title to ensure it is linked.
- Select a target and source branch
- Enter a description
- Create the pull request
As soon as you create a pull request in ClickUp or link an existing one a link to the associated ClickUp task will be added to the pull request!
Once a pull request is linked you will be able to see who opened it, the reviewer (if one is assigned), CI/CD status, and pull request status (open, review requested, under review, merged, closed) all from within the linked ClickUp task!
Connect Your Personal GitHub Account
In order to create branches and pull requests from ClickUp you need to connect your personal GitHub account. If you try to create a branch or pull request but have not connected your account you will be prompted to connect your GitHub account.
You can also connect or remove your GitHub account from ClickUp at anytime by doing the following:
- Click on your user avatar in the bottom right of the screen
- Select "My settings"
- Chose GitHub from the sidebar
- If your account is not connected there will be a button that says "Connect" you can click to log in to GitHub. If your account is connected already then it will say "Disconnect". Clicking it will remove your GitHub account from ClickUp.
NOTE: This only affects creating GitHub branches or pull requests from within ClickUp. It will NOT remove the associated repos or git activity from the Workspace. To do that you will need to be an admin and go to the Workspace settings.
NOTE: Guests cannot utilize this integration.
Automating your workflows
ClickUp's native Automations also support workflows with external applications like GitHub.
Unlock unparalleled development power with tons of GitHub automations to change the way you code alongside ClickUp. Select from numerous GitHub triggers and actions, and map data for an extended workflow.
Having trouble with Github? Chat with one of their representatives here.
Be sure to let us know what else you would like to see on our feedback board here!