Deploy

sdxc deploy

sdxc deploy ships an app in the only safe order: build, apply the production migrations, deploy. New code never reaches production ahead of the schema it expects, and a failed build or migration stops the run before anything is deployed.

How it asks the app

sdxc deploy runs no migration tool and no deploy tool of its own. It runs your project's build script with the project's package manager, then two commands on the app's own command line:

A new app's commands run cf d1 migrations list and cf d1 migrations apply against the database in cloudflare.config.ts, and cf deploy --prebuilt on the build in .cloudflare/output, signed in as your cf login or CLOUDFLARE_API_TOKEN. To migrate differently or deploy somewhere else, edit app/commands/db/migrate.ts or app/commands/deploy.ts, and sdxc deploy follows:

export default createCommand(commandset.deploy, async (ctx) => {
	let command = [
		"cf",
		"deploy",
		"--prebuilt",
		...(ctx.flags.dryRun ? ["--dry-run"] : []),
	];
	let deployed = await ctx.exec(command, { cwd: PROJECT_ROOT });
	return isFailure(deployed) ? deployed : success();
});

Keep the contract the table describes: --pending prints names and applies nothing, and deploy --dry-run uploads nothing. A db migrate without --pending still works; the plan then says db migrate --remote runs without listing what it applies, which is safe because applying a migration twice skips it.

The plan

Before it changes anything remote, sdxc deploy builds, lists the pending migrations, runs the app's deploy --dry-run, and prints the plan:

App:        my-app
Build:      built just now
Migrations: 1 pending
  0002_add_posts.sql
Deploy:     the app's deploy command

Then it asks Deploy my-app to production?, and the default answer is no. A no exits 1 and changes nothing. Migrations run only when some are pending.

Flags

• -y, --yes deploys without asking. A run without a terminal, such as CI, needs it, and stops with a usage error without it.

• --dry-run builds, lists, checks and prints the plan, then stops: nothing is migrated or deployed.

• --skip <step> leaves out build, migrate or deploy. Repeat it or list them: --skip build,migrate. --skip build deploys the output an earlier build wrote, and an app without a database passes --skip migrate. Skipping both migrate and deploy is refused, since it leaves nothing to run in production; with only deploy skipped, the question becomes Apply my-app's migrations to production?.

sdxc deploy --dry-run
sdxc deploy --yes --skip build
sdxc deploy --skip build --skip migrate

When a step fails

A failed step stops the run, and the message says what production runs now:

The deploy failure names the migrations it applied, so you know which schema the previous version is serving. Fix the cause and run sdxc deploy again: the migrations already applied are no longer pending, so the second run applies only the rest.

A project that cannot be deployed this way is named before anything runs: a missing bootstrap/cli.ts, a package.json without a build script (add one, or pass --skip build), an app command line without db migrate (add one, or pass --skip migrate), or without a deploy that takes --dry-run (add one, or pass --skip deploy).

In CI

sdxc deploy --yes

Put the secrets cf needs in the CI environment, and run sdxc doctor in an earlier step: it fails on a secret cloudflare.config.ts declares that CI cannot see.

Where to go next

• Run your app's commands — sdxc run db migrate on its own, locally or with --remote.

• Make a migration — write the migration a deploy applies.