Connecting GitHub and GitLab

GH Planner works best with GitHub linked to your account. Once you’re connected, GH Planner can:

• read pull request details, CI checks, changed files and reviews, including on private repositories you can access
• move tasks automatically as their pull requests change state
• post your task comments to the linked pull request
• approve, request changes on, close and merge pull requests from the task page
• open new pull requests from a task

Everything GH Planner does on GitHub is done as you, with your permissions. If you can’t merge a PR on GitHub, you can’t merge it from GH Planner either.

Connect GitHub

You can connect in any of these places:

• When you first open the planner: select Connect GitHub on the welcome prompt.
• From the planner: open GitHub Sync in the top menu.
• From Settings: open your profile menu, choose Profile & Settings, and find the GitHub section.

Then:

1. Select Connect GitHub.
2. GitHub asks you to authorise GH Planner. Review the access and approve it.
3. You’re returned to GH Planner and the GitHub section shows your connected username.

Organisation repositories

If your repositories belong to a GitHub organisation, the organisation may need to approve GH Planner before private repositories show up. Ask an organisation owner to approve the app under Settings → Third-party access on GitHub.

Connect GitLab

GitLab support is newer and covers merge requests. Go to Settings, find GitLab, select Connect and approve access on GitLab. Once connected you can:

• post task comments to GitLab merge requests
• approve and manage merge requests from the task page
• open new merge requests from GH Planner

Disconnect

Go to Settings, find the GitHub or GitLab section, and select Disconnect. Your tasks and links stay in place, but GH Planner stops syncing and you can’t run review actions until you reconnect.

To remove GH Planner’s access completely, also revoke it on GitHub under Settings → Applications → Authorized OAuth Apps.

Working without GitHub

You can use GH Planner as a plain kanban board without connecting anything. Boards, columns, tasks, labels, checklists, comments and sharing all work. Pull request linking, automation and review actions will be unavailable until you connect.