Preview branches docs #2130
Preview branches docs #2130
Conversation
|
WalkthroughA new documentation page titled "Preview branches" has been introduced, providing detailed instructions on creating and managing isolated preview environments for code branches. The documentation outlines workflows for preview branch creation, deployment, and archiving, including the use of environment variables and concurrency limits. It describes both automated methods using GitHub Actions and manual approaches via CLI or dashboard, complete with example commands and screenshots. Additionally, the navigation structure in the documentation has been updated to include this new page under the "Deployment" section. The deploy CLI command documentation was updated to support a new Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
SupportNeed help? Create a ticket on our support page for assistance with any issues or questions. Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (6)
docs/deployment/preview-branches.mdx (6)
12-13: Improve readability with commas: Consider adding commas for clarity. For example:-The Preview environment is special – you create branches from it. We recommend you automatically create a preview branch for each git branch when a Pull Request is opened and then archive it automatically when the PR is merged/closed. +The Preview environment is special – you create branches from it. We recommend you automatically create a preview branch for each git branch when a Pull Request is opened, and then archive it automatically when the PR is merged/closed.🧰 Tools
🪛 LanguageTool
[uncategorized] ~12-~12: Possible missing comma found.
Context: ... each git branch when a Pull Request is opened and then archive it automatically when ...(AI_HYDRA_LEO_MISSING_COMMA)
28-31: Add commas for compound sentences: To enhance readability, insert commas before conjunctions:-Once archived you can still view the dashboard for the branch but you can't trigger or execute runs (or other write operations). +Once archived, you can still view the dashboard for the branch, but you can't trigger or execute runs (or other write operations).🧰 Tools
🪛 LanguageTool
[uncategorized] ~30-~30: Use a comma before ‘but’ if it connects two independent clauses (unless they are closely connected and short).
Context: ... still view the dashboard for the branch but you can't trigger or execute runs (or o...(COMMA_COMPOUND_SENTENCE)
[misspelling] ~30-~30: It seems that the plural noun “others” fits better in this context.
Context: ...t you can't trigger or execute runs (or other write operations). This limit exists b...(OTHER_OTHERS)
40-40: Comma after introductory phrase: Add a comma after “For full details”:-For full details see our [pricing page](https://trigger.dev/pricing). +For full details, see our [pricing page](https://trigger.dev/pricing).🧰 Tools
🪛 LanguageTool
[uncategorized] ~40-~40: Possible missing comma found.
Context: ... | 20 (then paid for more) | For full details see our [pricing page](https://trigger....(AI_HYDRA_LEO_MISSING_COMMA)
104-111: Clarify flag usage: Add backticks around flags and adjust wording:-Notice that the deploy command has `--env preview` at the end. We automatically detect the preview branch from the GitHub actions env var. +Notice that the `deploy` command uses the `--env preview` flag. We automatically detect the preview branch from the GitHub Actions environment variable.🧰 Tools
🪛 LanguageTool
[uncategorized] ~106-~106: Loose punctuation mark.
Context: ...ub repository: -TRIGGER_ACCESS_TOKEN: A Trigger.dev personal access token (th...(UNLIKELY_OPENING_PUNCTUATION)
[grammar] ~108-~108: The word ‘deploy’ is a verb. Did you mean the noun “deployment” (= release, placement)?
Context: ...ersonal-access-token). Notice that the deploy command has--env previewat the end....(PREPOSITION_VERB)
[grammar] ~110-~110: The word ‘deploy’ is a verb. Did you mean the noun “deployment” (= release, placement)?
Context: ...h using--branch <branch-name>in the deploy command, but this isn't required. ## P...(PREPOSITION_VERB)
122-126: Fix infinitive and commas in instruction: For better flow:-If for some reason the auto-detection doesn't work it will let you know and tell you do this: +If, for some reason, auto-detection doesn't work, it will let you know and tell you to do this:🧰 Tools
🪛 LanguageTool
[typographical] ~122-~122: Consider wrapping this idiom with two commas if you want to put a strong emphasize on it.
Context: ...tomatically detecting the git branch. If for some reason the auto-detection doesn't work it will...(FOR_WHATEVER_REASON_COMMA)
[uncategorized] ~122-~122: Possible missing comma found.
Context: ... some reason the auto-detection doesn't work it will let you know and tell you do th...(AI_HYDRA_LEO_MISSING_COMMA)
[uncategorized] ~122-~122: Possible missing preposition found.
Context: ... work it will let you know and tell you do this: ```bash npx trigger.dev@v4-beta ...(AI_HYDRA_LEO_MISSING_TO)
135-136: Combine sentences and add commas: Improve readability:-Again we will try auto-detect the current branch. But you can specify the branch name with `--branch <branch-name>`. +Again, we will try to auto-detect the current branch, but you can specify the branch name with `--branch <branch-name>`.🧰 Tools
🪛 LanguageTool
[uncategorized] ~135-~135: Possible missing comma found.
Context: ...rigger.dev@v4-beta preview archive ``` Again we will try auto-detect the current bra...(AI_HYDRA_LEO_MISSING_COMMA)
[grammar] ~136-~136: The verb “auto-detect” needs to be in the to-infinitive form.
Context: ...beta preview archive ``` Again we will try auto-detect the current branch. But you can specify...(MISSING_TO_BEFORE_A_VERB)
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
⛔ Files ignored due to path filters (3)
docs/deployment/preview-branches-archive.pngis excluded by!**/*.pngdocs/deployment/preview-branches-new.pngis excluded by!**/*.pngdocs/deployment/preview-branches.pngis excluded by!**/*.png
📒 Files selected for processing (2)
docs/deployment/preview-branches.mdx(1 hunks)docs/docs.json(1 hunks)
🧰 Additional context used
🪛 LanguageTool
docs/deployment/preview-branches.mdx
[uncategorized] ~12-~12: Possible missing comma found.
Context: ... each git branch when a Pull Request is opened and then archive it automatically when ...
(AI_HYDRA_LEO_MISSING_COMMA)
[uncategorized] ~30-~30: Use a comma before ‘but’ if it connects two independent clauses (unless they are closely connected and short).
Context: ... still view the dashboard for the branch but you can't trigger or execute runs (or o...
(COMMA_COMPOUND_SENTENCE)
[misspelling] ~30-~30: It seems that the plural noun “others” fits better in this context.
Context: ...t you can't trigger or execute runs (or other write operations). This limit exists b...
(OTHER_OTHERS)
[uncategorized] ~32-~32: Possible missing comma found.
Context: ...endent concurrency limit. For the Cloud product these are the limits: | Plan | Active...
(AI_HYDRA_LEO_MISSING_COMMA)
[uncategorized] ~40-~40: Possible missing comma found.
Context: ... | 20 (then paid for more) | For full details see our [pricing page](https://trigger....
(AI_HYDRA_LEO_MISSING_COMMA)
[uncategorized] ~106-~106: Loose punctuation mark.
Context: ...ub repository: - TRIGGER_ACCESS_TOKEN: A Trigger.dev personal access token (th...
(UNLIKELY_OPENING_PUNCTUATION)
[grammar] ~108-~108: The word ‘deploy’ is a verb. Did you mean the noun “deployment” (= release, placement)?
Context: ...ersonal-access-token). Notice that the deploy command has --env preview at the end....
(PREPOSITION_VERB)
[grammar] ~110-~110: The word ‘deploy’ is a verb. Did you mean the noun “deployment” (= release, placement)?
Context: ...h using --branch <branch-name> in the deploy command, but this isn't required. ## P...
(PREPOSITION_VERB)
[typographical] ~122-~122: Consider wrapping this idiom with two commas if you want to put a strong emphasize on it.
Context: ...tomatically detecting the git branch. If for some reason the auto-detection doesn't work it will...
(FOR_WHATEVER_REASON_COMMA)
[uncategorized] ~122-~122: Possible missing comma found.
Context: ... some reason the auto-detection doesn't work it will let you know and tell you do th...
(AI_HYDRA_LEO_MISSING_COMMA)
[uncategorized] ~122-~122: Possible missing preposition found.
Context: ... work it will let you know and tell you do this: ```bash npx trigger.dev@v4-beta ...
(AI_HYDRA_LEO_MISSING_TO)
[uncategorized] ~135-~135: Possible missing comma found.
Context: ...rigger.dev@v4-beta preview archive ``` Again we will try auto-detect the current bra...
(AI_HYDRA_LEO_MISSING_COMMA)
[grammar] ~136-~136: The verb “auto-detect” needs to be in the to-infinitive form.
Context: ...beta preview archive ``` Again we will try auto-detect the current branch. But you can specify...
(MISSING_TO_BEFORE_A_VERB)
[uncategorized] ~140-~140: Possible missing comma found.
Context: ... dashboard From the "Preview branches" page you can create a branch: ![Preview bra...
(AI_HYDRA_LEO_MISSING_COMMA)
⏰ Context from checks skipped due to timeout of 90000ms (1)
- GitHub Check: Analyze (javascript-typescript)
🔇 Additional comments (8)
docs/docs.json (1)
103-103:❓ Verification inconclusive
Ensure new nav entry matches file path: You’ve added
"deployment/preview-branches"under the Deployment group. Please verify thatdocs/deployment/preview-branches.mdxexists and that this entry appears in the correct order in the sidebar.
🏁 Script executed:
#!/bin/bash test -f docs/deployment/preview-branches.mdx || echo "Missing docs/deployment/preview-branches.mdx"Length of output: 46
Let’s confirm this entry’s placement in the sidebar around the Deployment section:
🏁 Script executed:
#!/bin/bash rg -n -C5 '"deployment/preview-branches"' docs/docs.jsonLength of output: 496
Nav entry validated – file exists and placement confirmed
- docs/deployment/preview-branches.mdx is present.
- The sidebar entry at line 103 sits between
"github-actions"and"deployment/atomic-deployment"in the Deployment group.Please review this ordering to ensure it matches the intended navigation flow.
docs/deployment/preview-branches.mdx (7)
1-4: Frontmatter is well-structured: The title and description follow the existing pattern and clearly convey the purpose of the page.
6-9: Snippet import is correct and consistent: TheUpgradeToV4Noteis imported and used appropriately to surface upgrade notes.
32-39: Table formatting looks good: The concurrency limits table is clear and aligns with existing docs patterns.🧰 Tools
🪛 LanguageTool
[uncategorized] ~32-~32: Possible missing comma found.
Context: ...endent concurrency limit. For the Cloud product these are the limits: | Plan | Active...(AI_HYDRA_LEO_MISSING_COMMA)
42-51: Environment variable section is clear: The examples for settingTRIGGER_SECRET_KEYandTRIGGER_PREVIEW_BRANCHare concise and accurate.
53-67: SDK configuration snippet is accurate: The TypeScript example correctly demonstrates manual SDK configuration in edge runtimes.
69-102: GitHub Actions workflow example is comprehensive: The YAML snippet and accompanying explanation cover creation, deployment, and archiving steps clearly.
139-147:✅ Verification successful
Verify image path consistency: The image paths use a leading slash. Please confirm these align with other docs (e.g., no leading slash) to ensure assets load correctly.
🏁 Script executed:
#!/bin/bash # Check for image files in docs/deployment fd preview-branches.* docs/deploymentLength of output: 201
🏁 Script executed:
#!/bin/bash # List all image references in MDX files under docs to verify leading slash usage rg "!\[.*\]\(.*\)" docs -t mdx -nLength of output: 63
🏁 Script executed:
#!/bin/bash # Search all MDX files for image references to compare leading slash usage fd -e mdx docs | xargs rg "!\[.*\]\(" -nLength of output: 42
🏁 Script executed:
#!/bin/bash # Extract all image paths from docs (*.md, *.mdx) and count leading slash usage find docs -type f \( -name "*.md" -o -name "*.mdx" \) -print0 | xargs -0 grep -H -o '!\[[^]]*\]\([^)]*\)' | sed -E 's/.*\]\(([^)]+)\)/\1/' | awk '{ prefix = substr($0,1,1); print (prefix=="/"?"leading_slash":"no_slash"), $0 }' | sort | uniq -cLength of output: 9664
Image path consistency confirmed — no changes required
All image references across the
docs/directory use a leading slash (e.g./images/...,/deployment/...), and this snippet aligns with that pattern. No update is needed here.🧰 Tools
🪛 LanguageTool
[uncategorized] ~140-~140: Possible missing comma found.
Context: ... dashboard From the "Preview branches" page you can create a branch: ![Preview bra...(AI_HYDRA_LEO_MISSING_COMMA)
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (1)
docs/triggering.mdx (1)
31-31: Clarify how to set the preview branch variable.The note correctly calls out that
TRIGGER_PREVIEW_BRANCHmust be set when using preview branches. For users’ convenience, consider adding a brief example or link showing how to export this variable (e.g.,export TRIGGER_PREVIEW_BRANCH=feature/my-branch) or a reference to the exact format (matching the branch name).
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (2)
docs/apikeys.mdx(2 hunks)docs/triggering.mdx(1 hunks)
✅ Files skipped from review due to trivial changes (1)
- docs/apikeys.mdx
⏰ Context from checks skipped due to timeout of 90000ms (1)
- GitHub Check: Analyze (javascript-typescript)
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (7)
docs/deployment/preview-branches.mdx (7)
16-17: Clarify acronym and improve readabilityRecommend defining “Pull Request (PR)” on first mention and adding a comma for clarity:
- We recommend you automatically create a preview branch for each git branch when a Pull Request is opened and then archive it automatically when the PR is merged/closed. + We recommend you automatically create a preview branch for each git branch when a Pull Request (PR) is opened, and then archive it automatically when the PR is merged or closed.🧰 Tools
🪛 LanguageTool
[uncategorized] ~16-~16: Possible missing comma found.
Context: ... each git branch when a Pull Request is opened and then archive it automatically when ...(AI_HYDRA_LEO_MISSING_COMMA)
34-34: Add comma for compound sentenceInsert a comma before “but” for correct punctuation:
- Once archived you can still view the dashboard for the branch but you can't trigger or execute runs (or other write operations). + Once archived, you can still view the dashboard for the branch, but you can't trigger or execute runs (or other write operations).🧰 Tools
🪛 LanguageTool
[uncategorized] ~34-~34: Use a comma before ‘but’ if it connects two independent clauses (unless they are closely connected and short).
Context: ... still view the dashboard for the branch but you can't trigger or execute runs (or o...(COMMA_COMPOUND_SENTENCE)
[misspelling] ~34-~34: It seems that the plural noun “others” fits better in this context.
Context: ...t you can't trigger or execute runs (or other write operations). This limit exists b...(OTHER_OTHERS)
36-36: Insert missing commaAdd a comma after “Cloud product” for clarity:
- This limit exists because each branch has an independent concurrency limit. For the Cloud product these are the limits: + This limit exists because each branch has an independent concurrency limit. For the Cloud product, these are the limits:🧰 Tools
🪛 LanguageTool
[uncategorized] ~36-~36: A comma might be missing here.
Context: ...endent concurrency limit. For the Cloud product these are the limits: | Plan | Active...(AI_EN_LECTOR_MISSING_PUNCTUATION_COMMA)
126-126: Fix punctuation and missing wordAdd a comma and the word “to” for correct grammar:
- If for some reason the auto-detection doesn't work it will let you know and tell you do this: + If for some reason the auto-detection doesn't work, it will let you know and tell you to do this:🧰 Tools
🪛 LanguageTool
[typographical] ~126-~126: Consider wrapping this idiom with two commas if you want to put a strong emphasize on it.
Context: ...tomatically detecting the git branch. If for some reason the auto-detection doesn't work it will...(FOR_WHATEVER_REASON_COMMA)
[uncategorized] ~126-~126: Possible missing comma found.
Context: ... some reason the auto-detection doesn't work it will let you know and tell you do th...(AI_HYDRA_LEO_MISSING_COMMA)
[uncategorized] ~126-~126: Possible missing preposition found.
Context: ... work it will let you know and tell you do this: ```bash npx trigger.dev@v4-beta ...(AI_HYDRA_LEO_MISSING_TO)
139-140: Improve sentence flowConsider adding a comma and adjusting phrasing to combine sentences fluidly:
- Again we will try auto-detect the current branch. But you can specify the branch name with `--branch <branch-name>`. + Again, we will try to auto-detect the current branch, but you can specify the branch name with `--branch <branch-name>`.🧰 Tools
🪛 LanguageTool
[uncategorized] ~139-~139: Possible missing comma found.
Context: ...rigger.dev@v4-beta preview archive ``` Again we will try auto-detect the current bra...(AI_HYDRA_LEO_MISSING_COMMA)
[grammar] ~140-~140: The verb “auto-detect” needs to be in the to-infinitive form.
Context: ...beta preview archive ``` Again we will try auto-detect the current branch. But you can specify...(MISSING_TO_BEFORE_A_VERB)
144-144: Add comma after introductory phraseInsert a comma after “From the 'Preview branches' page”:
- From the "Preview branches" page you can create a branch: + From the "Preview branches" page, you can create a branch:🧰 Tools
🪛 LanguageTool
[uncategorized] ~144-~144: Possible missing comma found.
Context: ... dashboard From the "Preview branches" page you can create a branch: ![Preview bra...(AI_HYDRA_LEO_MISSING_COMMA)
155-155: Insert missing commaAdd a comma after “If they are set for both”:
- You can set environment variables for "Preview" and they will get applied to all branches (existing and new). You can also set environment variables for a specific branch. If they are set for both then the branch-specific variables will take precedence. + You can set environment variables for "Preview" and they will get applied to all branches (existing and new). You can also set environment variables for a specific branch. If they are set for both, then the branch-specific variables will take precedence.🧰 Tools
🪛 LanguageTool
[uncategorized] ~155-~155: Possible missing comma found.
Context: ... a specific branch. If they are set for both then the branch-specific variables will...(AI_HYDRA_LEO_MISSING_COMMA)
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
⛔ Files ignored due to path filters (2)
docs/deployment/preview-environment-branches.pngis excluded by!**/*.pngdocs/deployment/preview-environment-variables.pngis excluded by!**/*.png
📒 Files selected for processing (3)
docs/cli-preview-archive.mdx(1 hunks)docs/deployment/preview-branches.mdx(1 hunks)docs/docs.json(2 hunks)
✅ Files skipped from review due to trivial changes (2)
- docs/docs.json
- docs/cli-preview-archive.mdx
🧰 Additional context used
🪛 LanguageTool
docs/deployment/preview-branches.mdx
[uncategorized] ~16-~16: Possible missing comma found.
Context: ... each git branch when a Pull Request is opened and then archive it automatically when ...
(AI_HYDRA_LEO_MISSING_COMMA)
[uncategorized] ~18-~18: This verb may not be in the correct form. Consider using a different form for this context.
Context: ...he PR is merged/closed. The process to use preview branches looks like this: 1. C...
(AI_EN_LECTOR_REPLACEMENT_VERB_FORM)
[uncategorized] ~34-~34: Use a comma before ‘but’ if it connects two independent clauses (unless they are closely connected and short).
Context: ... still view the dashboard for the branch but you can't trigger or execute runs (or o...
(COMMA_COMPOUND_SENTENCE)
[misspelling] ~34-~34: It seems that the plural noun “others” fits better in this context.
Context: ...t you can't trigger or execute runs (or other write operations). This limit exists b...
(OTHER_OTHERS)
[uncategorized] ~36-~36: A comma might be missing here.
Context: ...endent concurrency limit. For the Cloud product these are the limits: | Plan | Active...
(AI_EN_LECTOR_MISSING_PUNCTUATION_COMMA)
[uncategorized] ~44-~44: Possible missing comma found.
Context: ... | 20 (then paid for more) | For full details see our [pricing page](https://trigger....
(AI_HYDRA_LEO_MISSING_COMMA)
[uncategorized] ~110-~110: Loose punctuation mark.
Context: ...ub repository: - TRIGGER_ACCESS_TOKEN: A Trigger.dev personal access token (th...
(UNLIKELY_OPENING_PUNCTUATION)
[grammar] ~112-~112: The word ‘deploy’ is a verb. Did you mean the noun “deployment” (= release, placement)?
Context: ...ersonal-access-token). Notice that the deploy command has --env preview at the end....
(PREPOSITION_VERB)
[grammar] ~114-~114: The word ‘deploy’ is a verb. Did you mean the noun “deployment” (= release, placement)?
Context: ...h using --branch <branch-name> in the deploy command, but this isn't required. ## P...
(PREPOSITION_VERB)
[typographical] ~126-~126: Consider wrapping this idiom with two commas if you want to put a strong emphasize on it.
Context: ...tomatically detecting the git branch. If for some reason the auto-detection doesn't work it will...
(FOR_WHATEVER_REASON_COMMA)
[uncategorized] ~126-~126: Possible missing comma found.
Context: ... some reason the auto-detection doesn't work it will let you know and tell you do th...
(AI_HYDRA_LEO_MISSING_COMMA)
[uncategorized] ~126-~126: Possible missing preposition found.
Context: ... work it will let you know and tell you do this: ```bash npx trigger.dev@v4-beta ...
(AI_HYDRA_LEO_MISSING_TO)
[uncategorized] ~139-~139: Possible missing comma found.
Context: ...rigger.dev@v4-beta preview archive ``` Again we will try auto-detect the current bra...
(AI_HYDRA_LEO_MISSING_COMMA)
[grammar] ~140-~140: The verb “auto-detect” needs to be in the to-infinitive form.
Context: ...beta preview archive ``` Again we will try auto-detect the current branch. But you can specify...
(MISSING_TO_BEFORE_A_VERB)
[uncategorized] ~144-~144: Possible missing comma found.
Context: ... dashboard From the "Preview branches" page you can create a branch: ![Preview bra...
(AI_HYDRA_LEO_MISSING_COMMA)
[uncategorized] ~155-~155: Possible missing comma found.
Context: ... a specific branch. If they are set for both then the branch-specific variables will...
(AI_HYDRA_LEO_MISSING_COMMA)
⏰ Context from checks skipped due to timeout of 90000ms (1)
- GitHub Check: Analyze (javascript-typescript)
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (5)
docs/deployment/preview-branches.mdx (5)
10-14: Section heading clarity
The heading "How to use preview branches" is clear. For smoother readability, consider rephrasing line 18 from:
“The process to use preview branches looks like this:”
to:
“The process for using preview branches is:”
18-24: Step list consistency
The numbered workflow is easy to follow. As a minor style tweak, wrap environment variables in backticks in step 3 for monospace formatting (TRIGGER_SECRET_KEY,TRIGGER_PREVIEW_BRANCH).🧰 Tools
🪛 LanguageTool
[uncategorized] ~18-~18: This verb may not be in the correct form. Consider using a different form for this context.
Context: ...he PR is merged/closed. The process to use preview branches looks like this: 1. C...(AI_EN_LECTOR_REPLACEMENT_VERB_FORM)
57-71: SDK configuration example
The TypeScript example is well-written. To emphasize the warning, you could bold the comment or wrap it in a callout component.
133-141: CLI archive commands
Thenpx trigger.dev@v4-beta preview archivesnippet is correct. For consistency, consider wrapping the--branch <branch-name>mention in backticks.🧰 Tools
🪛 LanguageTool
[uncategorized] ~139-~139: Possible missing comma found.
Context: ...rigger.dev@v4-beta preview archive ``` Again we will try auto-detect the current bra...(AI_HYDRA_LEO_MISSING_COMMA)
[grammar] ~140-~140: The verb “auto-detect” needs to be in the to-infinitive form.
Context: ...beta preview archive ``` Again we will try auto-detect the current branch. But you can specify...(MISSING_TO_BEFORE_A_VERB)
155-159: Environment variables section
Great explanation of global vs branch-specific variables. For better flow, insert a comma:
“If they are set for both, then the branch-specific variables will take precedence.”🧰 Tools
🪛 LanguageTool
[uncategorized] ~155-~155: Possible missing comma found.
Context: ... a specific branch. If they are set for both then the branch-specific variables will...(AI_HYDRA_LEO_MISSING_COMMA)
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
docs/deployment/preview-branches.mdx(1 hunks)
🧰 Additional context used
🪛 LanguageTool
docs/deployment/preview-branches.mdx
[uncategorized] ~18-~18: This verb may not be in the correct form. Consider using a different form for this context.
Context: ...he PR is merged/closed. The process to use preview branches looks like this: 1. C...
(AI_EN_LECTOR_REPLACEMENT_VERB_FORM)
[uncategorized] ~34-~34: Use a comma before ‘but’ if it connects two independent clauses (unless they are closely connected and short).
Context: ... still view the dashboard for the branch but you can't trigger or execute runs (or o...
(COMMA_COMPOUND_SENTENCE)
[misspelling] ~34-~34: It seems that the plural noun “others” fits better in this context.
Context: ...t you can't trigger or execute runs (or other write operations). This limit exists b...
(OTHER_OTHERS)
[uncategorized] ~36-~36: A comma might be missing here.
Context: ...endent concurrency limit. For the Cloud product these are the limits: | Plan | Active...
(AI_EN_LECTOR_MISSING_PUNCTUATION_COMMA)
[uncategorized] ~44-~44: Possible missing comma found.
Context: ... | 20 (then paid for more) | For full details see our [pricing page](https://trigger....
(AI_HYDRA_LEO_MISSING_COMMA)
[uncategorized] ~110-~110: Loose punctuation mark.
Context: ...ub repository: - TRIGGER_ACCESS_TOKEN: A Trigger.dev personal access token (th...
(UNLIKELY_OPENING_PUNCTUATION)
[grammar] ~112-~112: The word ‘deploy’ is a verb. Did you mean the noun “deployment” (= release, placement)?
Context: ...ersonal-access-token). Notice that the deploy command has --env preview at the end....
(PREPOSITION_VERB)
[grammar] ~114-~114: The word ‘deploy’ is a verb. Did you mean the noun “deployment” (= release, placement)?
Context: ...h using --branch <branch-name> in the deploy command, but this isn't required. ## P...
(PREPOSITION_VERB)
[typographical] ~126-~126: Consider wrapping this idiom with two commas if you want to put a strong emphasize on it.
Context: ...tomatically detecting the git branch. If for some reason the auto-detection doesn't work it will...
(FOR_WHATEVER_REASON_COMMA)
[uncategorized] ~126-~126: Possible missing comma found.
Context: ... some reason the auto-detection doesn't work it will let you know and tell you do th...
(AI_HYDRA_LEO_MISSING_COMMA)
[uncategorized] ~126-~126: Possible missing preposition found.
Context: ... work it will let you know and tell you do this: ```bash npx trigger.dev@v4-beta ...
(AI_HYDRA_LEO_MISSING_TO)
[uncategorized] ~139-~139: Possible missing comma found.
Context: ...rigger.dev@v4-beta preview archive ``` Again we will try auto-detect the current bra...
(AI_HYDRA_LEO_MISSING_COMMA)
[grammar] ~140-~140: The verb “auto-detect” needs to be in the to-infinitive form.
Context: ...beta preview archive ``` Again we will try auto-detect the current branch. But you can specify...
(MISSING_TO_BEFORE_A_VERB)
[uncategorized] ~144-~144: Possible missing comma found.
Context: ... dashboard From the "Preview branches" page you can create a branch: ![Preview bra...
(AI_HYDRA_LEO_MISSING_COMMA)
[uncategorized] ~155-~155: Possible missing comma found.
Context: ... a specific branch. If they are set for both then the branch-specific variables will...
(AI_HYDRA_LEO_MISSING_COMMA)
⏰ Context from checks skipped due to timeout of 90000ms (1)
- GitHub Check: Analyze (javascript-typescript)
🔇 Additional comments (9)
docs/deployment/preview-branches.mdx (9)
36-43: Active preview branches table
Your Markdown table is correctly formatted and conveys the limits per plan clearly. The link to the pricing page is appropriate here.🧰 Tools
🪛 LanguageTool
[uncategorized] ~36-~36: A comma might be missing here.
Context: ...endent concurrency limit. For the Cloud product these are the limits: | Plan | Active...(AI_EN_LECTOR_MISSING_PUNCTUATION_COMMA)
48-55: Triggering runs environment variables
The bash snippet for settingTRIGGER_SECRET_KEYandTRIGGER_PREVIEW_BRANCHis correct and easy to copy.
81-107: GitHub Actions workflow
You’ve added the file path in the code fence (.github/workflows/trigger-preview-branches.yml). Verify that your MDX parser handles fence metadata; otherwise, switch to a plainyamltag.
119-128: CLI deploy commands
The manual CLI snippet usingnpx trigger.dev@v4-beta deploy --env previewis accurate and aligns with the automated workflow.🧰 Tools
🪛 LanguageTool
[typographical] ~126-~126: Consider wrapping this idiom with two commas if you want to put a strong emphasize on it.
Context: ...tomatically detecting the git branch. If for some reason the auto-detection doesn't work it will...(FOR_WHATEVER_REASON_COMMA)
[uncategorized] ~126-~126: Possible missing comma found.
Context: ... some reason the auto-detection doesn't work it will let you know and tell you do th...(AI_HYDRA_LEO_MISSING_COMMA)
[uncategorized] ~126-~126: Possible missing preposition found.
Context: ... work it will let you know and tell you do this: ```bash npx trigger.dev@v4-beta ...(AI_HYDRA_LEO_MISSING_TO)
165-183: syncEnvVars build extension snippet
Your MDX/TS example clearly shows how to wire in thesyncEnvVarsextension and usectx.branch.
185-203: syncVercelEnvVars example
The Vercel extension snippet is straightforward. Ensure that users know they must install@trigger.dev/build/extensions/coreas noted above.
6-8:✅ Verification successful
Snippet import path check
You haveimport UpgradeToV4Note from "/snippets/upgrade-to-v4-note.mdx". Confirm that/snippets/upgrade-to-v4-note.mdxexists in your repo or that your MDX setup resolves absolute/snippetspaths correctly.
🏁 Script executed:
rg -l 'upgrade-to-v4-note.mdx'Length of output: 246
🏁 Script executed:
#!/bin/bash # Confirm the existence and path of the snippet file in the repo find . -type f -name 'upgrade-to-v4-note.mdx'Length of output: 84
Verified snippet import path
The fileupgrade-to-v4-note.mdxexists atdocs/snippets/upgrade-to-v4-note.mdx, so the importimport UpgradeToV4Note from "/snippets/upgrade-to-v4-note.mdx";correctly resolves to the snippet. No changes required.
143-151:✅ Verification successful
Dashboard screenshots
You reference/deployment/preview-branches.pngand/deployment/preview-branches-new.png. Confirm these image files exist in the repo and path is correct.
🏁 Script executed:
rg -l 'preview-branches-new.png'Length of output: 69
I’ll verify that the referenced images actually exist in the repo:
🏁 Script executed:
#!/bin/bash # Check for all referenced preview-branches images find . -type f \( -name 'preview-branches.png' -o -name 'preview-branches-new.png' -o -name 'preview-branches-archive.png' \)Length of output: 252
All referenced dashboard screenshots are present
- docs/deployment/preview-branches.png
- docs/deployment/preview-branches-new.png
- docs/deployment/preview-branches-archive.png
Paths in the MDX (
/deployment/…) correctly point to these files.🧰 Tools
🪛 LanguageTool
[uncategorized] ~144-~144: Possible missing comma found.
Context: ... dashboard From the "Preview branches" page you can create a branch: 
This is a Work In Progress for the Preview docs