Add a provider
Teach RelayRunner to recognize another runner service, with a pull request.
The dashboard recognizes runner services by their runs-on labels, so it can show where every job ran and what it cost. The list lives in code and changes by pull request. If a service you use shows up as Other, you can add it.
What to change
Section titled “What to change”- The provider’s facts in
packages/providers/src/index.ts: add an id toPROVIDER_IDSand an entry toPROVIDERSwith its name, a one-line summary, how its labels look, an exampleruns-on, and links to its docs and dashboard. Addhidden: trueso it starts Hidden: its jobs are recognised, but the Providers page doesn’t offer it until an operator makes it Live in Admin › Providers. The dashboard and these docs both read from here. - Its list prices, if it publishes them, in
packages/providers/src/prices.ts, with a comment naming the price page. Prices are estimates for the Providers page, so leave out plan allowances and discounts. - How to match its labels in
LABEL_PREFIXESin the same file, with its id inHOSTED_PROVIDER_IDS, and the slug of its GitHub App inAPP_SLUG_PATTERNS. Most services use a prefix, such asdepot-. If it refuses public repos or personal accounts, add it toSKIPS_PUBLIC_REPOSorSKIPS_PERSONAL_ACCOUNTS, and give itautosizes inauto-sizes.tsthat every account can run. Add a case topackages/providers/src/index.test.ts. - Its logo: an SVG in
apps/site/public/providers/, and the icon and brand color the dashboard uses inapps/web/src/components/providers.tsxandapps/web/src/styles.css.
Run pnpm check from the repo root before you open the pull request. The repo’s README covers setup.
Recognized and routed
Section titled “Recognized and routed”A provider in HOSTED_PROVIDER_IDS is also a step in the runner order. To route to it, add an input of the same name to the relay workflow in relayrunner/actions too, and its prefixes to the copy in apps/cli/src/init/workflows.rs.