Connect GitHub to a Project

If your team writes code, connecting GitHub keeps the work and the code together. Each task suggests a branch name, and once you push to that branch, its commits and pull requests appear on the task, so anyone can see where a piece of work has got to without asking.

Before you start

• Projects are on the Professional and Enterprise plans.
• You need a GitHub personal access token with access to the repositories you want to link.

Connect GitHub

Open Settings from the gear icon in the top bar, choose Integrations, find GitHub and enter your personal access token. Using Bitbucket instead? It is in the same place.

Link a repository to the project

1. Open the project's repositories

   In the project's settings, open the repositories and choose to link one. Search for it by name; private repositories are included.

2. Check the webhook

   Each linked repository shows its default branch and whether its webhook is active. The webhook is what sends commits and pull requests back to Wizard Application, so if it shows as missing, check your token can manage webhooks.

3. Choose your branch name format

   Set how branch names are built from the task. You can use the task key, such as PROJ-123, the task title and the task type, for example feature or bug.

Work from a task

1. Copy the suggested branch name

   Open a task and copy its suggested branch name.

2. Create the branch

   Create a branch with exactly that name in your repository and start work as usual.

3. Watch it update

   Commits and pull requests on that branch appear on the task automatically.

For more, see the GitHub integration.