Skip to content

chore(env): 明確標註 conversion API env ownership - #327

Merged
monkey1sai merged 4 commits into
mainfrom
chore/env-example-hygiene-20260713
Jul 13, 2026
Merged

monkey1sai merged 4 commits into
mainfrom
chore/env-example-hygiene-20260713

Conversation

@monkey1sai

@monkey1sai monkey1sai commented Jul 13, 2026 •

Copy link
Copy Markdown
Owner

摘要

  • 在 root .env.example 明確標註 conversion/storage env key 的 ownership 與退役邊界。
  • 在 bim-review-coordinator/.env.example 登記空值 legacy alias CONVERSION_API_BASE;既有 STREAMING_CONVERSION_API_BASE precedence 不變。
  • 未修改 .env、runtime code、public API 或預設啟用狀態。

驗證

  • npm test -- tests/config.test.ts tests/env-example-minio-watch-parity.test.ts:28 tests passed。
  • pwsh -NoProfile -NonInteractive -File .\scripts\tests\test-preflight-env.ps1:ALL PASSED。
  • npm run verify(bim-review-coordinator):build passed,56 test files / 611 tests passed。
  • git diff --check:passed。
  • GitNexus detect_changes(compare main):2 files、0 symbols、risk low。

Deploy Path Verification

欄位 內容
Affects runtime / docker / Kit / viewer / ports / env? Yes — .env.example key ownership/documentation only;不改 runtime default 或 production .env
Canonical deploy path updated? Existing canonical path retained;scripts/deploy.ps1 無需修改,已用 DryRun 驗證
Deploy dry-run command .\scripts\deploy.ps1 -DryRun passed;Phase 2 skipped,未執行任何 auto-fix
Verify command npm run verify(611 tests)+ scripts/tests/test-preflight-env.ps1 passed

已知風險

  • npm ci 回報既有 dependency audit:8 moderate、3 high、1 critical;本 PR 不擴大到 dependency upgrade。
  • DryRun 在隔離 worktree 回報 .env/venv/build 尚未建立及既有 runtime ports 被外部程序占用;不影響本次 read-only DryRun,且未停止任何程序。
  • 非 user-facing capability,沒有 frontend route/button/E2E claim。

Summary by CodeRabbit

  • Documentation
    • Updated environment configuration guidance for retired and legacy settings.
    • Clarified which conversion service setting to use and where BIM control configuration belongs.
    • Documented the legacy conversion alias and recommended replacement.
    • Added guidance for removing obsolete local environment entries.

Formal spec 與執行計畫

Copilot AI review requested due to automatic review settings July 13, 2026 03:21
@coderabbitai

coderabbitai Bot commented Jul 13, 2026 •

Copy link
Copy Markdown
Contributor

Review Change Stack

Warning

Review limit reached

@monkey1sai, you've reached your PR review limit, so we couldn't start this review.

Next review available in: 14 minutes

Enable usage-based reviews in Billing to review now. Otherwise, wait until the next included review is available.
You're only billed for reviews past your plan's rate limits ($0.25/file).

How can I continue?

After more reviews become available, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

To avoid repeated limits, reduce automatic review volume by pausing incremental auto-reviews earlier, using label-based review opt-in, excluding WIP or generated PR titles, or requesting reviews manually when the PR is ready. If your team needs uninterrupted high-volume reviews, an organization admin can enable usage-based reviews.

How do review limits work?

CodeRabbit enforces per-developer PR review limits for each organization. Most developers receive the normal plan review availability.

For paid Pro and Pro+ PR reviews, CodeRabbit uses adaptive limits for sustained high-volume activity. When a developer's recent PR review activity reaches the 95th percentile or higher among CodeRabbit users, additional reviews become available more gradually as earlier reviews age out of the rolling window.

Please refer docs for additional details.

Review details
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: 9bfc068c-e3e8-4f8f-bc7e-9ee5d8ba7ccf

📥 Commits

Reviewing files that changed from the base of the PR and between d9b2d13 and 9218509.

📒 Files selected for processing (3)
  • bim-review-coordinator/.env.example
  • docs/superpowers/plans/2026-07-13-conversion-api-env-ownership-closeout.md
  • docs/superpowers/specs/2026-07-13-conversion-api-env-ownership-design.md
📝 Walkthrough

Walkthrough

The environment examples now document retired legacy keys, identify STREAMING_CONVERSION_API_BASE as the preferred conversion endpoint, clarify coordinator scope, and add a CONVERSION_API_BASE alias placeholder.

Changes

Environment variable guidance

Layer / File(s) Summary
Legacy conversion key guidance
.env.example, bim-review-coordinator/.env.example
Root and coordinator environment examples clarify retired key handling, scope, cleanup guidance, and the CONVERSION_API_BASE alias for STREAMING_CONVERSION_API_BASE.

Estimated code review effort: 1 (Trivial) | ~2 minutes

Possibly related PRs

Suggested reviewers: copilot

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed Title accurately reflects the main change: clarifying ownership and legacy handling for conversion API env keys.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch chore/env-example-hygiene-20260713

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.

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copilot encountered an error and was unable to review this pull request. You can try again by re-requesting a review.

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 1

🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In `@bim-review-coordinator/.env.example`:
- Line 6: Move the CONVERSION_API_BASE placeholder before the HOST entry in the
environment example, preserving its existing value and keeping the file
compliant with dotenv-linter key ordering.
🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

  • Push a commit to this branch (recommended)
  • Create a new PR with the fixes

ℹ️ Review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: 15784e82-c3b1-44bc-a802-7e79f4047abd

📥 Commits

Reviewing files that changed from the base of the PR and between 4fb753e and d9b2d13.

📒 Files selected for processing (2)
  • .env.example
  • bim-review-coordinator/.env.example

Comment thread bim-review-coordinator/.env.example Outdated
@monkey1sai
monkey1sai marked this pull request as draft July 13, 2026 03:24
monkey1sai and others added 2 commits July 13, 2026 11:31
記錄 root 與 coordinator 的 key ownership、legacy precedence、空值 placeholder、安全邊界與驗證門檻。

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
記錄 PR #327 的 local preflight、CI/reviewer、squash merge 與 worktree closeout gates。

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
@monkey1sai
monkey1sai marked this pull request as ready for review July 13, 2026 03:53
@monkey1sai
monkey1sai merged commit e8a6964 into main Jul 13, 2026
13 checks passed
@monkey1sai
monkey1sai deleted the chore/env-example-hygiene-20260713 branch July 13, 2026 04:13
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.

2 participants