Connect GitHub

A job reaches BoxRouter only after all three of these are true:

The GitHub App installation includes the repository.
A workspace administrator connects that installation to BoxRouter.
A workspace administrator turns on the repository in BoxRouter.

Before You Begin: Private repositories you can manage, and administrator rights in the BoxRouter workspace. For an organization, an owner may have to approve the App first.

Connect an Account

In BoxRouter, open GitHub Actions. Under Connect GitHub, choose one path.

Install the App
Link an Existing Install

Choose Connect A GitHub Org.
In GitHub, pick the owner of the repositories.
Review the permissions, choose Only select repositories, and pick the private repositories to try.
Complete the install. GitHub returns you to BoxRouter.

If GitHub asks an organization owner to approve the installation, the connection completes after that approval. Installations appear under Account → Integrations, where every workspace you administer can use them. If a repository is missing, the installation does not include it or your GitHub account cannot manage it. Add it under the installation’s repository access in GitHub, then reload the list in BoxRouter.

Permissions

The App’s manifest asks for these, and GitHub shows the same list before you approve:

Permission	Access	What BoxRouter Does with It
Administration	Write	Creates the one-time runner registration for each job.
Actions	Write	Cancels or re-runs a workflow run from BoxRouter.
Checks	Write	Posts a BoxRouter check on the commit when a job is refused.
Contents	Read	Mints a read-only token for a private repository you have connected, scoped to that repository.
Metadata	Read	Required by GitHub for every App.

For job operations, BoxRouter requests short-lived installation tokens scoped to the repository and the permissions each operation needs. The App is notified of push, workflow_job, workflow_run, and installation and repository changes.

Turn Repositories On

In GitHub Actions, turn on each repository. Installing the App sends no job to BoxRouter. A job runs there only when its workflow uses a BoxRouter label, as in Run your first GitHub job.

Disconnect

Choose Disconnect on the account’s row under Account → Integrations. New jobs stop being accepted. Disconnecting does not cancel a running job or remove its sandbox; find any job still running in Find a run.

Next Steps

Run Your First GitHub Job

Change one line and find the run.

How Actions Security Works

Which jobs run and where secrets stay.

Choose a Runner

Labels, sizes, and time limits.

Get Started

Run Jobs

Reference