Orangescrum
Documentation index for AI agents (llms.txt). A markdown version of this page is available at /integrations/github.md or by requesting this URL with the header Accept: text/markdown.
GitHub

GitHub Integration for the Work Behind the Code

Map a GitHub repository to an Orangescrum project once. Issues and comments stay in step, and in the Self-Hosted edition the board shows what your pipeline is actually doing.

Available inCloudSelf-HostedOpen Source

Repository and issue sync in Cloud and Self-Hosted - the DevOps layer is Self-Hosted

What does the GitHub integration do?

The GitHub integration links a GitHub repository to an Orangescrum project so the two stay in step. Issues and tasks sync both ways, comments and labels are carried across, and repository events arrive by webhook rather than being polled. In the Self-Hosted edition it goes further into delivery: you can create a branch or a pull request straight from a work item, see GitHub Actions status against the task, have a commit status written back, and stop a merge until the linked task reaches a status you allow.

The problem

Why the board and the repository disagree

The same work is tracked twice
A GitHub issue and a project task, updated separately until nobody knows which one is right.
Two way sync keeps one story in both places.
Nobody can trace a branch to a task
Branch names are invented per developer, so linking code back to the plan is guesswork.
Create the branch from the work item, with the identifier already in the name.
Managers ask developers for build status
The pipeline result lives in GitHub and the people who need it do not go there.
GitHub Actions status shows on the work item, in Self-Hosted.
What you get

Your repository, connected to your projects

Issue and comment sync in both editions, with the delivery layer on top of it in Self-Hosted.
  • Repository to project mapping

    Connect over OAuth and map each GitHub repository to the Orangescrum project that owns that work.

  • Two way issue sync

    Issues and tasks stay in step, with state and priority translated between the two, so a change on either side lands on the other.

  • Comment sync

    Comments made on the issue and on the task are carried across, so one discussion does not end up split between two tools.

  • Label sync

    GitHub labels map to Orangescrum, so the way your team categorises work survives the trip between tools.

  • Webhook updates

    Repository events arrive by webhook and are verified against your webhook secret, so updates land as they happen rather than on a schedule.

  • Create a branch from a task

    Start a GitHub branch from the work item, with the task identifier in the name so commits link back on their own. Available in Self-Hosted.

  • Create a pull request from a task

    Open the pull request from the work item rather than switching tools to do it. Available in Self-Hosted.

  • Actions status and merge gating

    See GitHub Actions status on the work item, have a commit status written back, and block a merge until the linked task reaches an allowed status. Available in Self-Hosted.

How it works

How to connect it

1
Connect GitHub
Authorise Orangescrum against your GitHub account or organisation. In Cloud the OAuth application is already registered for you. In Self-Hosted you register your own.
2
Map repositories to projects
Point each repository at the Orangescrum project that owns that work, and choose what should sync.
3
Reference tasks in your work
Put the work item identifier in branch names, commit messages, and pull request titles so Orangescrum can link them to the right task.
4
Add the delivery layer
In Self-Hosted, turn on Actions status and set which workflow statuses are allowed to merge.
Who it's for

For teams that build on GitHub

Software teams
Developers who want the board to match what is happening in the repository.
Learn more →
Mixed toolchains
Organisations running GitHub alongside GitLab or Azure DevOps in different teams.
Learn more →
Regulated delivery
Teams that must show work was reviewed and passing before it merged.
Learn more →
Availability

Which edition includes what

Orangescrum runs as managed cloud, self-hosted on your own servers, or as the open-source Community Edition. Here is exactly what each one includes.
Issue and comment sync are in Cloud and Self-Hosted. The delivery layer is Self-Hosted.
CapabilityCloudManaged SaaSSelf-HostedOn-premise / private cloudOpen SourceCommunity Edition
Repository connection and project mapping
Two way issue and task sync
Comment sync
Label sync
Webhook updates with signature verification
Create a branch from a work item
Create a pull request from a work item
GitHub Actions status on the work item
Merge gating by workflow status
Frequently asked questions

GitHub integration FAQ

Does Orangescrum integrate with GitHub?

Yes. You connect a GitHub account over OAuth, map repositories to Orangescrum projects, and issues, comments, and labels then sync both ways. Repository events arrive by webhook, so the two sides stay in step without polling.

Which edition includes what?

Repository connection, issue sync, comment sync, label sync, and webhooks are in both the Cloud and Self-Hosted editions. Branch creation, pull request creation, GitHub Actions status, commit status write back, and merge gating are Self-Hosted only. None of this is in the free Community Edition.

Can I create a branch or a pull request from a task?

Yes, in the Self-Hosted edition. Both are started from the work item, and the branch carries the task identifier in its name so later commits and pull requests link back on their own.

Does it show GitHub Actions status?

Yes, in the Self-Hosted edition. Actions results are normalised alongside GitLab CI, Jenkins, and Bitbucket Pipelines, so a mixed toolchain still gives one consistent view of build status on the work item.

How does Orangescrum know which task a commit belongs to?

It reads the work item identifier out of branch names, commit messages, and pull request titles, and resolves it against the project mapped to that repository.

Do I need to register an OAuth app?

In the Cloud edition, no. The OAuth application is registered centrally and you just authorise the connection. In the Self-Hosted edition you create your own GitHub OAuth app and enter the credentials, which are encrypted before they are stored.

Does it work with GitHub Enterprise Server?

The connection is configured with the instance and credentials you supply, so a self-managed GitHub can be reached as long as your Orangescrum server can. Self-hosting both sides keeps the traffic inside your own network.

Can I stop a merge until the task is ready?

Yes, in the Self-Hosted edition. Merge gating blocks a pull request until the linked work item reaches a workflow status you allow, and the result is written back as a commit status so developers see it in GitHub.

Connect GitHub to your projects

Issue and comment sync are available in Cloud and Self-Hosted. Branch and pull request creation, Actions status, and merge gating are part of the Self-Hosted edition.