-
-
Notifications
You must be signed in to change notification settings - Fork 888
docs(build-server): adjust build env vars section #2605
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Conversation
Adds a clarification about the env var prefix stripping.
|
WalkthroughUpdates documentation in docs/github-integration.mdx to clarify that on the build server the TRIGGER_BUILD_ prefix is removed from variable names, exposing only the suffix (e.g., TRIGGER_BUILD_MY_TOKEN -> MY_TOKEN). The explanatory text is wrapped in a tag for formatting. Estimated code review effort🎯 1 (Trivial) | ⏱️ ~2 minutes Single-file documentation clarification; no code or logic changes. Pre-merge checks and finishing touches❌ Failed checks (1 warning)
✅ Passed checks (2 passed)
✨ Finishing touches🧪 Generate unit tests (beta)
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. Comment |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Actionable comments posted: 0
🧹 Nitpick comments (2)
docs/github-integration.mdx (2)
97-98: Good clarification on prefix stripping; add precedence and timing.Looks good. Please also state:
- Which wins if both MY_TOKEN and TRIGGER_BUILD_MY_TOKEN are set.
- When stripping happens (before prebuild/install/build commands).
Suggested addition (verify correctness):
In the build server, the `TRIGGER_BUILD_` prefix is stripped from the variable name, i.e., `TRIGGER_BUILD_MY_TOKEN` is exposed as `MY_TOKEN`. +The prefix is stripped before any pre-build, install, and build commands run. If both `MY_TOKEN` and `TRIGGER_BUILD_MY_TOKEN` are present, the build-prefixed value takes precedence during build steps.
101-103: Clarify build-time scope vs. runtime persistence.Explicitly note these vars are not persisted to the app/runtime or logs to avoid confusion.
- Build environment variables only apply to deployments in the environment you set them in. + Build environment variables only apply to deployments in the environment you set them in and are only available during build and deploy steps on the build server. They are not persisted to your project's runtime environment or application logs.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
docs/github-integration.mdx(1 hunks)
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (1)
- GitHub Check: Analyze (javascript-typescript)
Adds a clarification about the env var prefix stripping.