GitHub Automations

  • Updated

Using our GitHub integration to sync work between GitHub and ClickUp? Add GitHub Automations to build an efficient workflow. Software teams can reduce context switching using Automations to keep everything up-to-date.

What you'll need

  • Github Automations are available on every ClickUp Plan.
  • GitHub Automations count towards the number of Actions available per month, which varies by Plan.
  • A Workspace owner or admin must enable the Automation ClickApp.

  • You'll need admin permissions to the GitHub repository to set up Automations.
  • Guests can't use the GitHub integration.

Add a GitHub Automation in ClickUp

You can add GitHub Automations at the Space, Folder, and Lists level of the ClickUp Hierarchy.

  1. Browse to the location where you want to set up the GitHub Automation.
  2. Open the Automations modal.
    • Click Automations in the top-right corner
    • Or click the ellipsis in the Sidebar and click Automations.
  3. Click the Browse tab.
  4. Select Github from the menu on the left.
  5. Select the Automation you want to use, or click Show More to see more available GitHub Automations.
  6. Connect your GitHub account using the following options:
    • Pick from the dropdown list of existing GitHub accounts.
      • To update a previously authorized GitHub account, you must remove and re-add it.
      • Removing an account will not impact any existing Automations that use that account. You will need to re-add it to create GitHub Automations in the future.
    • Enter your GitHub user name and click Connect Account and authorize ClickUp.
    • Or click Create an account to create a new account on GitHub.com.
  7. Specify who can use your GitHub account to create Automations.
  8. Configure the Trigger, Conditions, and Actions.
    • Each GitHub Automation allows you to pick a specific repository (repo).
    • The options available will vary depending on the GitHub Automation you're using.
  9. Click Save.
  10. Consider giving your GitHub Automation a meaningful description to help others understand what it does.

GitHub Automations

GitHub Automations use the same structure as Automations in ClickUp.

Every Automation consists of a Trigger and an Action. Users on the Business Plan and above have the option to use Conditions.

GitHub Triggers

When the following events happen in the specified GitHub repo, and the Conditions are met, the Automation will run and perform an Action.

  • 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

GitHub Conditions

GitHub Automations related to pull requests support one or more Conditions.

For example, you can update the task status when a pull request to the main branch is linked. Or set the task priority to urgent and comment when a pull request with the hotfix label is merged to the QA branch.

Conditions can be set for multiple combinations of pull request labels, base ref, and head ref values.

Condition logic

You can use the following Condition logic:

  • is any of: The pull request includes at least one of the specified labels or branches.
  • is all of: The pull request includes all of the specified labels or branches.
  • is not any of: The pull request does not include any of the specified labels or branches.
  • is not all of: The pull request does not include all of the specified labels or branches.

For labels, you can use the logic listed above and:

  • is set: At least one label has been applied to the pull request.
  • is not set: No labels have been applied to the pull request.

Add a Condition

To add a Condition to your GitHub Automation:

  1. From an Automation, under the Trigger section, click Add Condition.
  2. Select what the condition should apply to:
    • Githublabelcondition: Labels applied to the pull request.
    • Head ref: The source branch containing your proposed changes.
    • Base ref: The target branch where your changes will be applied.
  3. Select the Condition logic.
  4. Choose the label or branch value to use with this condition.

    Conditions are case-sensitive. They must match the label or branch name exactly or they will not meet the criteria and trigger the Automation.

  5. Click Add another to include an additional label or branch value to use.
  6. Click Add Condition to add multiple Conditions.

ClickUp Actions

Every Automation Action except our webhook action is available to update tasks using GitHub Triggers.

For Automation Actions to be applied to existing tasks, the task must already be linked to the GitHub repo by linking a commit, branch, or pull request. The Create Task action is the only exception, as new tasks can't be linked in advance.

GitHub Actions

You can use Automations with the Create Issue Action, which creates a new issue in GitHub.

For example, when a bug form is submitted and creates a task in a specific List, an Automation can create an issue in Github.

Was this article helpful?