How it fits together
A Space connects to GitHub once. A project then links the repositories it works in. Work items find their branch and pull request through the work item key.Connect a Space
1
Open the Space settings
Open Space Settings and choose Integrations in the Space group.
2
Connect GitHub
Click Connect GitHub and approve the App on GitHub. If the instance has no GitHub App yet, a system administrator has to do this first step.
3
Check the result
Back in Collabase, you see GitHub connected, repositories synced and the status Connected.
Link a repository to a project
1
Open the project settings
In the project, open Settings and choose Integrations in the Project group.
2
Link the repository
Under Linked Repositories, click Link Repository, then Select repository. Use Sync first if a new repository is missing from the list.
Work on a work item
Open a work item and click the GitHub icon in its top bar to open the panel.1
Create the branch
Click Create Branch. Pick the Repository when the project has more than one. Leave Custom name empty to get a name built from your initials, the key and the title, for example
jd/proj-12-fix-login. The branch starts from the repository’s default branch.2
Work on the branch
Use Copy to copy the branch name into your Git client, or View on GitHub.
3
Open the pull request
Click Create Pull Request. It opens the GitHub compare page in a new tab, where you create the pull request.
Comments on the pull request appear as comments on the work item, written by the user GitHub.
How Collabase finds the work item
Collabase looks for a work item key, such asPROJ-12, in the branch name. For a pull request it uses the branch name first and the PR title second. Branches you create from the panel always contain the key.
Commit messages are not read. Collabase links branches and pull requests, not individual commits, and there are no smart commits.
Change the status automatically
Under Settings → Integrations → Automation Rules, a project admin defines which status a work item gets when a GitHub event occurs. Nothing is preset: a merged pull request does not close a work item until you add a rule.
The action is always Select status. For more complex reactions to GitHub events, use the GitHub connector of Automation.
Limits
Troubleshooting
Related
Work items
The detail view and its panels.
GitHub connector
Triggers and actions for Automation.