Skip to main content
When GitHub queues a job whose runs-on is a BoxRouter label, BoxRouter starts a fresh sandbox for it and registers a runner in it. GitHub still starts the workflow and keeps its logs, artifacts, and secrets. Before You Begin: A private GitHub repository you administer, and a connected provider key or Credits in a BoxRouter workspace where you are an administrator.

Add a Test Workflow

Save this as .github/workflows/boxrouter-smoke.yml and commit it to the repository’s default branch. GitHub requires the file there for manual runs. It does not check out your code.
boxrouter-ubuntu-24.04 requests the default size. Runners lists its CPU and memory floors and the other sizes.

Connect GitHub and Turn the Repository On

1

Connect

In BoxRouter, open GitHub Actions and connect the account or organization that owns the repository. Connect GitHub covers the permissions and the existing-installation path.
2

Turn the Repository On

Under Choose Repositories, turn on the switch beside your repository. The row shows Turning On… while BoxRouter prepares it, then On. For any other status, see repository status.

Run It

On GitHub, open Actions, choose BoxRouter smoke test, and select Run workflow. The job runs on a runner named like brx-…. If it stays queued, see Job stays queued. Your CPU count can differ from the 4 shown here. On routes that enforce CPU with a quota, nproc reports the host’s count; see worker counts. In BoxRouter, the run is at the top of the GitHub Actions table. Open it to see the provider, size, and timeline. Check the cleanup status to confirm the sandbox was deleted. To follow the sandbox itself, see Find a run.

Limits to Know First

Before moving another workflow, check runner limits for supported jobs, time limits, and available tools.

Next Steps

Move a Workflow

Pick a label, check the diff, and roll back.

How Actions Works

What happens between a queued job and a finished one.

Choose a Runner

The labels, sizes, and time limits.