Skip to content

Conversation

@myftija
Copy link
Member

@myftija myftija commented Oct 14, 2025

Adds a clarification about the env var prefix stripping.

Adds a clarification about the env var prefix stripping.
@changeset-bot
Copy link

changeset-bot bot commented Oct 14, 2025

⚠️ No Changeset found

Latest commit: 391120f

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

@coderabbitai
Copy link
Contributor

coderabbitai bot commented Oct 14, 2025

Walkthrough

Updates 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)
Check name Status Explanation Resolution
Description Check ⚠️ Warning The provided description is only a one-sentence summary and does not follow the repository’s required description template, as it lacks the issue reference, checklist, testing instructions, changelog entry, and any screenshots. Please update the description to include a “Closes #” line, complete the checklist of contribution steps and testing, add a detailed testing section, provide a changelog summary, and include any relevant screenshots.
✅ Passed checks (2 passed)
Check name Status Explanation
Title Check ✅ Passed The pull request title clearly indicates that documentation for build-server environment variables has been adjusted and follows the conventional “docs(scope): description” format, concisely summarizing the main change to the env var section.
Docstring Coverage ✅ Passed No functions found in the changes. Docstring coverage check skipped.
✨ Finishing touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch build-server-docs-env-var-prefixes

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.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

Copy link
Contributor

@coderabbitai coderabbitai bot left a 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

📥 Commits

Reviewing files that changed from the base of the PR and between f646168 and 391120f.

📒 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)

@myftija myftija merged commit aa66462 into main Oct 14, 2025
7 checks passed
@myftija myftija deleted the build-server-docs-env-var-prefixes branch October 14, 2025 15:29
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants