Skip to Content
Apso is in public beta. Get started

apso deploy

Deploy the linked service to the Apso platform. Runs a local migration check before deploying to catch schema issues early.

Usage

apso deploy apso deploy --yes apso deploy --skip-migrate apso deploy --no-wait apso deploy --repo your-org/project-api --branch main

Options

OptionDescriptionDefault
-y, --yesSkip confirmation promptfalse
--skip-migrateSkip local migration validationfalse
--no-waitTrigger deploy without waiting for completionfalse
--skip-pushRedeploy the source already connected to the servicefalse
--repo <owner/name>Select a GitHub repository when none is connectednone
--branch <name>Select the branch to pushmain
--local-gitPush with local Git credentials instead of the platform connectionfalse

Deploy flow

  1. Verifies you are authenticated and the project is linked
  2. Parses the current .apsorc schema
  3. Runs the migration sandbox to validate schema changes (unless --skip-migrate)
  4. If migrations are detected, shows the SQL and asks for confirmation (unless --yes)
  5. If the migration fails locally, the deploy is blocked
  6. Synchronizes local source to the connected GitHub repository unless --skip-push is set
  7. Triggers the build on the platform
  8. Polls for build completion and reports the result unless --no-wait is set

Examples

Deploy with all checks:

apso deploy

Deploy in CI (no prompts, no waiting):

apso deploy --yes --no-wait

Deploy without migration check:

apso deploy --skip-migrate

Connect a repository and use local Git credentials:

apso deploy --repo your-org/project-api --branch main --local-git

Prerequisites

  • Must be authenticated (apso login)
  • Project must be linked to a platform service (apso link)
  • GitHub must be connected (apso github connect) unless the deployment uses source that is already synchronized
Last updated on