Skip to content

cli-commands-deploy.mdx

Latest commit

 

History

History
98 lines (66 loc) · 2.93 KB

cli-commands-deploy.mdx

File metadata and controls

98 lines (66 loc) · 2.93 KB

import ProjectPathArg from "/snippets/cli-args-project-path.mdx"; import CommonOptions from "/snippets/cli-options-common.mdx"; import ProjectRefOption from "/snippets/cli-options-project-ref.mdx"; import EnvFileOption from "/snippets/cli-options-env-file.mdx"; import ConfigFileOption from "/snippets/cli-options-config-file.mdx"; import SkipUpdateCheckOption from "/snippets/cli-options-skip-update-check.mdx"; import BranchOption from "/snippets/cli-options-branch.mdx";

Run the command like this:

npx trigger.dev@latest deploy
pnpm dlx trigger.dev@latest deploy
yarn dlx trigger.dev@latest deploy
This will fail in CI if any version mismatches are detected. Ensure everything runs locally first using the [dev](/cli-dev-commands) command and don't bypass the version checks!

It performs a few steps to deploy:

  1. Optionally updates packages when running locally.
  2. Compiles and bundles the code.
  3. Deploys the code to the Trigger.dev instance.
  4. Registers the tasks as a new version in the environment (prod by default).

Deploying from CI

When deploying from CI/CD environments such as GitHub Actions, GitLab CI, or Jenkins, you need to authenticate non-interactively by setting the TRIGGER_ACCESS_TOKEN environment variable. Please see the CI / GitHub Actions guide for more information.

Arguments

npx trigger.dev@latest deploy [path]

Options

Defaults to `prod` but you can specify `staging` or `preview`. If you specify `preview` we will try and automatically detect the branch name from git. Create a deployable build but don't deploy it. Prints out the build path so you can inspect it. Skips automatically promoting the newly deployed version to the "current" deploy. Turn off syncing environment variables with the Trigger.dev instance. Force building the deployment image locally using your local Docker. This is automatic when self-hosting.

Common options

These options are available on most commands.

Self-hosting

When self-hosting, builds are performed locally by default. Once you've logged in to your self-hosted instance using the CLI, you can deploy with:

npx trigger.dev@latest deploy

For CI/CD environments, set TRIGGER_ACCESS_TOKEN and TRIGGER_API_URL environment variables. See the GitHub Actions guide for more details.