With ClickUp's Github integration, users can associate Github commits, branches, and pull requests 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
#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 Team.
Step 3: Attach Personal Repositories to Team Repositories
ClickUp allows multiple people to authorize Github within your Team, and also permits you to customize which repositories are shared with your Team.
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 anyway. 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 of the
Team Repos . Select one or more Spaces to attach repositories to.
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 commit, pull request, or branch title with a hashtag in front of it.
Manually associating Github Activity
- Click the Github icon on any task
- Select a Repo
- Select a Branch
- Attach your 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 a hashtag in front of it, as well as the status you want inside brackets
Watch the task's status change in this video. Example: #ud5b[ready]
Coming Soon: Actions
Soon, you’ll be able to perform Git actions directly inside of ClickUp.
Do you ever need to create a new feature branch? With Actions, you’ll be able to click to branch off and associate the branch and future commits to a ClickUp task automatically.
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!