fix(developer-docs): use plain KEY=VALUE format in plane.env example - #502
fix(developer-docs): use plain KEY=VALUE format in plane.env example#502sriramveeraghanta wants to merge 1 commit into
Conversation
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
|
Warning Review limit reached
Next review available in: 16 minutes Limit details: You’ve used the included review currently available. You've used all free OSS reviews for now. Wait for the free limit to reset to keep reviewing this public repository. How can I continue?Wait for the limit to reset, then comment An organization admin can change what happens after included review limits in Billing. How do review limits work?CodeRabbit enforces per-developer PR review limits within each organization. For paid Pro and Pro+ reviews, CodeRabbit uses a developer's included PR review attempts over the past 7 days to set the current hourly allowance. At typical activity levels, the full plan allowance applies. Higher sustained activity can lower the allowance until earlier attempts leave the 7-day window. Please refer docs for additional details. Review details⚙️ Run configurationConfiguration used: defaults Review profile: CHILL Plan: Pro Plus Run ID: 📒 Files selected for processing (1)
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: defaults Review profile: CHILL Plan: Pro Plus Run ID: 📒 Files selected for processing (1)
Included review availability: Your plan provides up to 1 included review per hour; 0 remain after this review. 📝 WalkthroughWalkthroughThe airgapped deployment guide now documents ChangesAirgapped configuration
Estimated code review effort: 1 (Trivial) | ~2 minutes Merge Risk: ⚪ Minimal · up to This localized documentation change is merge-ready after normal checks; no actionable merge-blocking risk remains. Suggested reviewers: 🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 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 |
`docker compose --env-file` does not support shell `export` syntax, so the air-gapped `plane.env` snippet now uses plain `KEY=VALUE` lines. Replace the `$(uuidgen)` command substitution with a literal placeholder and a note telling users to run `uuidgen` and paste the output as `MACHINE_SIGNATURE`. Ports makeplane/developer-docs#318. Claude-Session: https://claude.ai/code/session_01QbJp4uYoTdvYsBLeRfSJv1
2d088fa to
5ef3448
Compare
Summary
Ports makeplane/developer-docs#318 into this monorepo — the change landed upstream after
apps/developer-docswas imported at 03dcb34, so it never made it here.export KEY=valuewith plainKEY=valuein the air-gappedplane.envexample —docker compose --env-filedoes not parse shellexportsyntaxMACHINE_SIGNATURE=$(uuidgen)with a literal placeholder plus a:::infonote telling users to runuuidgenand paste the outputNote
The upstream PR's base already had
SITE_ADDRESS=https://plane.yourcompany.comin that snippet; this repo's copy did not. It's included here, since it's a required Caddy variable and part of the merged upstream state. Happy to drop the line if that omission was deliberate.Test plan
pnpm check:formatpassesKEY=VALUEthroughoutuuidgennote renders as an info container and reads clearlyhttps://claude.ai/code/session_01QbJp4uYoTdvYsBLeRfSJv1
Summary by CodeRabbit
MACHINE_SIGNATURE.plane.envusing a generated UUID.