From f60d29cfc93d67b15d4e25283291eaab59d83a89 Mon Sep 17 00:00:00 2001 From: Eric Allam Date: Tue, 2 Sep 2025 12:16:12 +0100 Subject: [PATCH] chore(docs): improve version pinning advise to use installed trigger.dev CLI --- docs/github-actions.mdx | 13 +++++++------ 1 file changed, 7 insertions(+), 6 deletions(-) diff --git a/docs/github-actions.mdx b/docs/github-actions.mdx index 9fba762fae..0fe0788cce 100644 --- a/docs/github-actions.mdx +++ b/docs/github-actions.mdx @@ -102,13 +102,16 @@ If you already have a GitHub action file, you can just add the final step "🚀 ## CLI Version pinning The CLI and `@trigger.dev/*` package versions need to be in sync with the `trigger.dev` CLI, otherwise there will be errors and unpredictable behavior. Hence, the `deploy` command will automatically fail during CI on any version mismatches. -Tip: add the deploy command to your `package.json` file to keep versions managed in the same place. For example: +Tip: add the `trigger.dev` CLI to your `devDependencies` and the deploy command to your `package.json` file to keep versions managed in the same place. For example: ```json { "scripts": { - "deploy:trigger-prod": "npx trigger.dev@3.0.0 deploy", - "deploy:trigger": "npx trigger.dev@3.0.0 deploy --env staging" + "deploy:trigger-prod": "trigger deploy", + "deploy:trigger": "trigger deploy --env staging" + }, + "devDependencies": { + "trigger.dev": "4.0.2" } } ``` @@ -134,9 +137,7 @@ When self-hosting, you will have to take a few additional steps: - Add your registry credentials to the GitHub secrets. - Use the `--self-hosted` and `--push` flags when deploying. - - If you're self-hosting v4, the `--self-hosted` and `--push` flags are **NOT** needed. - +If you're self-hosting v4, the `--self-hosted` and `--push` flags are **NOT** needed. Other than that, your GitHub action file will look very similar to the one above: