Skip to content

Commit f60d29c

Browse files
committed
chore(docs): improve version pinning advise to use installed trigger.dev CLI
1 parent b0b0df6 commit f60d29c

File tree

1 file changed

+7
-6
lines changed

1 file changed

+7
-6
lines changed

docs/github-actions.mdx

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -102,13 +102,16 @@ If you already have a GitHub action file, you can just add the final step "🚀
102102
## CLI Version pinning
103103

104104
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.
105-
Tip: add the deploy command to your `package.json` file to keep versions managed in the same place. For example:
105+
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:
106106

107107
```json
108108
{
109109
"scripts": {
110-
"deploy:trigger-prod": "npx trigger.dev@3.0.0 deploy",
111-
"deploy:trigger": "npx trigger.dev@3.0.0 deploy --env staging"
110+
"deploy:trigger-prod": "trigger deploy",
111+
"deploy:trigger": "trigger deploy --env staging"
112+
},
113+
"devDependencies": {
114+
"trigger.dev": "4.0.2"
112115
}
113116
}
114117
```
@@ -134,9 +137,7 @@ When self-hosting, you will have to take a few additional steps:
134137
- Add your registry credentials to the GitHub secrets.
135138
- Use the `--self-hosted` and `--push` flags when deploying.
136139

137-
<Tip>
138-
If you're self-hosting v4, the `--self-hosted` and `--push` flags are **NOT** needed.
139-
</Tip>
140+
<Tip>If you're self-hosting v4, the `--self-hosted` and `--push` flags are **NOT** needed.</Tip>
140141

141142
Other than that, your GitHub action file will look very similar to the one above:
142143

0 commit comments

Comments
 (0)