ClickUp's native Automations also support workflows with external applications.
Integrate GitHub to automate your GitHub workflow within ClickUp! Select from numerous GitHub triggers and actions, and map data for an extended workflow.
This is helpful in managing code reviews, pull requests, and branches with ease. For example, when a pull request is open in GitHub, you can automatically change the status in ClickUp to 'Review Requested'.
How to enable GitHub
1. Open the automation center in ClickUp
Select the List you'd like to automate and open the Automation center. Click the GitHub option in the sidebar to see all of the Automations you can create!
Once you've chosen the Automation you want to create, you'll be taken to a new screen where you can add an account OR pick from any existing accounts that you have access to.
2. Add your GitHub account
- Click
Connect Account - Authorize ClickUp to use your Github account
- Set who will be able to use this account to create automations
Note: Once you save an account, you cannot edit it. The only way is to remove that account and re-authenticate it. Removing an account will not break any automations that use that account. It will just make that account unavailable as an option when creating new automations.
That's it! You're ready to setup GitHub automations in ClickUp.
What you can do with GitHub Automations
Add a Github repo to an Automation
To add a GitHub repo to an automation, enter the name of that repo in the following format organization-name/repo-name .
For example let's say you wanted to add the React repo you would enter is as facebook/react
GitHub Triggers
- Branch created
- PR/MR created
- Branch merged to x branch
- Commit is merged to x branch
- PR/MR is merged to x branch
- Branch linked
- PR/MR linked
- PR/MR status change
- On commit
- CI/CD status change (fail, passed)
Actions available within ClickUp
Every action except our web hook action is available to use with GitHub triggers.
It is important to note though that every action except for create task will only work if the relevant task is already linked to a GitHub pull request, commit, or branch. If the relevant task is not already linked then the automation will not fire. The create task action will always work.
GitHub Actions
- Create issue
Conditions
If you're using a Github trigger that is related to a pull request, then you can set conditions! These conditions can be set for pull request labels, base ref, and head ref. Conditions are case sensitive so they must match the label, base ref, or head ref exactly - otherwise they will not work.
Data mapping
Dynamically map data when creating a new task! Open the drop down next to a field to see all supported fields from GitHub. Set static values if you want to do something like assign every task created to a certain person! Even more powerful is the ability to now insert data from Github into text fields dynamically. This means you can have custom generated titles, descriptions, or more!