RelayRunner docs: Move your workflows over Page: https://relayrunner.dev/docs/get-started/move-over Markdown: https://relayrunner.dev/docs/get-started/move-over.md All pages: https://relayrunner.dev/docs/llms.txt Other pages (Markdown): - Route GitHub Actions jobs to any runner: https://relayrunner.dev/docs/get-started/overview.md - How it works with GitHub Actions: https://relayrunner.dev/docs/get-started/github-actions.md - Quickstart: https://relayrunner.dev/docs/get-started/quickstart.md - Install the CLI: https://relayrunner.dev/docs/get-started/install.md - RelayRunner for Mac: https://relayrunner.dev/docs/get-started/mac-app.md - Set up with an agent: https://relayrunner.dev/docs/get-started/agents.md - Move your workflows over: https://relayrunner.dev/docs/get-started/move-over.md (this page) - Principles: https://relayrunner.dev/docs/concepts/principles.md - Routing: https://relayrunner.dev/docs/concepts/routing.md - Runner order: https://relayrunner.dev/docs/concepts/runner-order.md - Optimized checks: https://relayrunner.dev/docs/concepts/optimized-checks.md - Spend controls: https://relayrunner.dev/docs/guides/spend-controls.md - Providers: https://relayrunner.dev/docs/runners/providers.md - Your machines: https://relayrunner.dev/docs/runners/self-hosted.md - GitHub-hosted: https://relayrunner.dev/docs/runners/github.md - Hosted providers: https://relayrunner.dev/docs/runners/hosted.md - Runner labels: https://relayrunner.dev/docs/reference/labels.md - Add a provider: https://relayrunner.dev/docs/contribute/add-provider.md - Run CI on your laptop while you work: https://relayrunner.dev/docs/guides/laptop-ci.md - macOS and iOS builds on your Mac: https://relayrunner.dev/docs/guides/mac-builds.md - Share your team's machines: https://relayrunner.dev/docs/guides/team-machines.md - Keep up with coding agents: https://relayrunner.dev/docs/guides/agent-surge.md - Activity and history: https://relayrunner.dev/docs/dashboard/activity.md - Signals: https://relayrunner.dev/docs/dashboard/signals.md - Performance: https://relayrunner.dev/docs/dashboard/performance.md - Usage and savings: https://relayrunner.dev/docs/dashboard/usage.md - Telemetry: https://relayrunner.dev/docs/dashboard/telemetry.md - AI: https://relayrunner.dev/docs/dashboard/ai.md - CLI: https://relayrunner.dev/docs/reference/cli.md - relay.yml inputs: https://relayrunner.dev/docs/reference/relay-inputs.md - Repo config: https://relayrunner.dev/docs/reference/repo-config.md - MCP server: https://relayrunner.dev/docs/reference/mcp.md - RelayRunner API: https://relayrunner.dev/docs/reference/api.md - Workspaces and members: https://relayrunner.dev/docs/dashboard/workspaces.md - GitHub App: https://relayrunner.dev/docs/reference/github-app.md - Security: https://relayrunner.dev/docs/reference/security.md - Data and privacy: https://relayrunner.dev/docs/reference/privacy.md - Remove RelayRunner: https://relayrunner.dev/docs/dashboard/remove.md - Troubleshooting: https://relayrunner.dev/docs/reference/troubleshooting.md - Errors: https://relayrunner.dev/docs/reference/errors.md - FAQ: https://relayrunner.dev/docs/reference/faq.md - Feedback: https://relayrunner.dev/docs/contribute/feedback.md - Changelog: https://relayrunner.dev/docs/changelog.md - Agents can change your routing: https://relayrunner.dev/docs/changelog/agent-changes.md - Pick runner sizes on the dashboard: https://relayrunner.dev/docs/changelog/auto-runner-sizes.md - CLI changelog: https://relayrunner.dev/docs/changelog/cli.md - Send job logs to your tools or your own bucket: https://relayrunner.dev/docs/changelog/job-log-export.md - Mac app changelog: https://relayrunner.dev/docs/changelog/mac.md - RelayRunner for Mac: https://relayrunner.dev/docs/changelog/mac-app.md - CI traces in your observability tool: https://relayrunner.dev/docs/changelog/opentelemetry-traces.md - Platform changelog: https://relayrunner.dev/docs/changelog/platform.md - Retries, queueing and provider usage: https://relayrunner.dev/docs/changelog/retries-queueing-and-provider-usage.md - Route a repo from the dashboard: https://relayrunner.dev/docs/changelog/route-a-repo.md - Clearer run times and job sizes for members: https://relayrunner.dev/docs/changelog/run-times.md - Usual times, job history and the Mac queue: https://relayrunner.dev/docs/changelog/usual-times-and-mac-queue.md --- # Move your workflows over > What relayrunner init changes in your GitHub Actions workflows, and which jobs it leaves alone. Routing a job through RelayRunner is one change: a relay job in front of it, and a `runs-on` that points at the relay's answer. `relayrunner init` makes that change for you. ## Run init Inside a checkout of the repo: ```sh npx relayrunner init ``` It sorts every job into three groups and lets you pick from the first: - **Ready.** The job uses a plain GitHub-hosted label (`ubuntu-*`, `macos-*`) or a hosted provider's label, such as `blacksmith-*` or `depot-*`. Warnings flag what to check first, such as a job that needs Docker or installs Linux packages when your machine runs jobs on itself and not in a VM. - **Already routed.** The job already runs where a relay sends it. - **Skipped, with the reason.** See below. To see the list without changing anything, run `relayrunner init --plan`. To route jobs without prompts, run `relayrunner init --apply test,lint`, or `--apply all` for every ready job. Add `--auto` to set Linux x64 jobs' sizes on the Router page instead of in the file. ## Route repos from the dashboard On the dashboard's Router page, **Route a repo** takes you through one repo at a time: 1. Pick a repo. Repos your org's Default runner group leaves out are marked, with the fix. 2. Pick its jobs from recent runs, and a size for each if you want one other than the default. 3. Copy a prompt for your coding agent, which runs `init` and opens a PR, or copy the `init` command. After you copy, the sheet waits for the repo's first routed run and says when it's routed. **Next repo** moves on, and from the second repo one prompt can cover the rest. ## What it writes For a job like this: ```yaml jobs: test: runs-on: ubuntu-latest steps: ... ``` `init` writes: ```yaml jobs: relay-test: uses: relayrunner/actions/.github/workflows/relay.yml@v1 with: machine: self-hosted github: ubuntu-latest test: needs: relay-test runs-on: ${{ needs.relay-test.outputs.runner }} steps: ... ``` The old label moves to the relay's `github` input (or the provider's own input, such as `depot`, for a hosted provider's label), so the job still runs there when no machine is free. A `macos-*` job gets `machine: macOS`, so it only goes to Macs. `init` keeps your comments and formatting, and never commits. Push the change. The check keeps its name in GitHub, so required checks and branch protection keep working. ## Jobs it skips - **Deploy jobs.** Jobs that use secrets, a deploy environment, or an OIDC token to sign in to a cloud or publish a package. Running one on a machine gives that machine those secrets, so it's your call. To route one anyway, add `--allow-deploy `. A job that only requests an OIDC token, such as for a remote cache, isn't skipped. - **Jobs pinned to a label list or runner group**, such as `runs-on: [self-hosted, m1, macmini]`. The relay falls back to one label, so to route one by hand, pick what kind of machine may take it (`machine: macOS, ARM64`) and a hosted label for when none is free. - **Matrix jobs.** One relay answers one job, so it can't serve every leg of a matrix. - **Reusable workflows.** They choose their own runner. - **Windows jobs**, and jobs on a single `self-hosted` label. ## Public repos `init` refuses public repositories, since their jobs [never run on your machines](/docs/concepts/principles#public-repositories-never-run-on-your-machines). ## Undo Delete the relay job and put the old label back in `runs-on`. Or leave the change in place: with no machine online and GitHub in your runner order, jobs run on their old label anyway.