GitHub Automations

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

1. Click Connect Account

2. Authorize ClickUp to use your Github account

3. 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

When your work in GitHub is updated, use an Automation to keep your ClickUp tasks up to date.

When you are working in ClickUp, use an Automation to create an issue in GitHub!

Note: Users will need admin permissions to access repos for automations.

GitHub Triggers

When the following events happen in GitHub, and the Conditions are met, the Automation will run and perform the Action(s).

• Pull Request Merged

• Branch Merged

• On Commit

• Pull Request Review Created

• Pull Request Review Updated

• CI/CD Status Changed

• Pull Request Linked

• Branch Linked

• Commit Linked

Select a Github repo to an Automation

To choose which GitHub repo to use in an Automation, select a repo from the dropdown menu:

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.

Actions available within ClickUp

Every action except our web hook action is available to use with GitHub triggers.

Every Automation 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

When you are doing work in ClickUp, you can create an Automation to create an issue in GitHub:

• Create issue

A real world example

First, create a GitHub Automation at the List level:

1. When: Pull request linked

2. Action: Change status to In Review

Next, create and link a pull request to test the Automation:

1. Create a new task in ClickUp with id abc123

2. Create a new branch called testing

3. Update files in the repo and push a commit on the testing branch

4. Create a pull request to merge changes from this branch to main

5. Link the pull request to task abc123

Result: The Automation updates task abc123 status to In Review

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!