Onboard a repo¶
Onboarding is what makes a repo deployable. Until you onboard, the control plane won't accept deploys from it. You do this once per repo.
What it does¶
One command, three effects:
- Registers the repo with the control plane, bound to your GitHub App installation. This is the allowlist entry that lets the repo deploy, and it takes effect right away with no restart.
- Writes
mithran.yamlat the repo root if one isn't there yet. It won't overwrite an existing manifest. - Adds
.github/workflows/map-deploy.yml(the deploy trigger) and sets the repo Actions variables the workflow needs (MAP_INSTALLATION_REF,MAP_APP_REF, and your tenant/account refs).
Commit the files it created:
Useful flags¶
--repo-dir <path>: where to write the scaffolded files. Use.from inside a checkout.--installation-ref <ref>: the GitHub App installation to deploy under. Setup usually fills this in; pass it explicitly if you manage more than one.--tenant-ref,--account-ref,--project-ref: your tenancy refs.project-refdefaults toapp:<repo-name>.
See the CLI reference for the full list.
If you get a 409¶
A 409 from onboard means the GitHub App isn't installed on that repo, or hasn't been granted access to it. Onboard prints the install link. Open it, grant the repo, and run onboard again. Background on the install flow is in Connect GitHub.
Confirm it took¶
doctor checks that the repo is registered and deployable. Then move on to Deploy.