Skip to content

docs: name combo hang-stop from comboPredicates.ts - #14054

Merged
diegosouzapw merged 1 commit into
diegosouzapw:release/v3.8.51from
HouMinXi:fix/14004-env-doc-sync
Sep 22, 2026
Merged

diegosouzapw merged 1 commit into
diegosouzapw:release/v3.8.51from
HouMinXi:fix/14004-env-doc-sync

Conversation

@HouMinXi

@HouMinXi HouMinXi commented Sep 18, 2026 •

Copy link
Copy Markdown
Contributor

Related to #14004. The tracker already closed after 7cc454d93 went release-green.

#14022 landed the STRIP documentation and the DOC_ONLY_ALLOWLIST entry for COMBO_LOOP_SAFETY_TIMEOUT_MS. Rebased onto that tip; the STRIP overlap is gone.

What is left:

  • ENVIRONMENT.md no longer backticks the hang-stop constant as an env name. It points at comboPredicates.ts instead. The allowlist already keeps the checker green; this is the prose form of the same fact.
  • changelog fragment for that sentence.

node scripts/check/check-env-doc-sync.mjs on this tree: 613 / 825 / 842, all three directions none, exit 0.

⚠️ base-red inherited: #13866

@HouMinXi

Copy link
Copy Markdown
Contributor Author

This PR documents both gaps that make check-env-doc-sync red on current release/v3.8.51:

  1. OMNIROUTE_STRIP_SYSTEM_PREAMBLE is a real process.env read (openai-to-claude.ts) missing from .env.example / ENVIRONMENT.md. Same fix as fix(ci): document OMNIROUTE_STRIP_SYSTEM_PREAMBLE — the env/docs base red blocking every PR #14022, but this branch is on current tip (0 behind). fix(ci): document OMNIROUTE_STRIP_SYSTEM_PREAMBLE — the env/docs base red blocking every PR #14022 is 14 behind and only covers this key.
  2. COMBO_LOOP_SAFETY_TIMEOUT_MS is a hardcoded constant in comboPredicates.ts. Backticks in ENVIRONMENT.md made the checker treat it as an env var. fix(ci): document OMNIROUTE_STRIP_SYSTEM_PREAMBLE — the env/docs base red blocking every PR #14022 does not touch that. Merging fix(ci): document OMNIROUTE_STRIP_SYSTEM_PREAMBLE — the env/docs base red blocking every PR #14022 onto current tip still leaves the contract red.

If #14022 lands first, this PR rebases and drops the STRIP overlap, keeping only the constant prose change.

@HouMinXi

Copy link
Copy Markdown
Contributor Author

#14004 closed itself after release/v3.8.51 went green at 7cc454d93 (run 35338595127).

#14022 is already on that tip. It documents OMNIROUTE_STRIP_SYSTEM_PREAMBLE and allowlists COMBO_LOOP_SAFETY_TIMEOUT_MS in DOC_ONLY_ALLOWLIST. I re-ran node scripts/check/check-env-doc-sync.mjs on 7cc454d931:

Code references:          613 unique vars
In .env.example:          825 unique vars
In docs/reference/ENVIRONMENT.md: 843 unique vars
  ✓ In code but missing from .env.example: none
  ✓ In .env.example but missing from ENVIRONMENT.md: none
  ✓ In ENVIRONMENT.md but missing from .env.example: none
✓ Env / docs contract is in sync.

This PR's leftover vs current tip is the STRIP overlap plus a prose rewrite of the hang-stop sentence. The allowlist already covers that name, so the rewrite is unused. Closing as superseded by #14022.

Related to #14004. The issue is already closed.

@HouMinXi HouMinXi closed this Sep 18, 2026
@HouMinXi HouMinXi reopened this Sep 18, 2026
@HouMinXi

Copy link
Copy Markdown
Contributor Author

Reopened. I closed this by mistake; that call is the maintainer's.

#14022 already landed on 7cc454d93 and the env/docs checker is green there (DOC_ONLY_ALLOWLIST covers COMBO_LOOP_SAFETY_TIMEOUT_MS). This branch still has the STRIP overlap plus a prose rewrite of the hang-stop sentence. Leaving the PR open for you to drop or retarget.

@HouMinXi
HouMinXi force-pushed the fix/14004-env-doc-sync branch from 20f438b to f37f1bb Compare September 18, 2026 12:09
@HouMinXi

Copy link
Copy Markdown
Contributor Author

Rebased onto 7cc454d93 (#14022 already on that tip).

STRIP documentation is already on the branch. The remaining unique diff is the ENVIRONMENT.md sentence that still backticks COMBO_LOOP_SAFETY_TIMEOUT_MS as if it were an env var, plus a changelog fragment for that sentence. The allowlist already keeps check-env-doc-sync green; this is the prose form of the same fact.

Local node scripts/check/check-env-doc-sync.mjs on this tree: 613 / 825 / 842, all three directions none, exit 0.

#14004 stays with whoever owns the tracker.

@HouMinXi HouMinXi changed the title fix(docs): env/docs contract for STRIP_SYSTEM_PREAMBLE and combo hang-stop docs: name combo hang-stop from comboPredicates.ts Sep 18, 2026
@HouMinXi
HouMinXi force-pushed the fix/14004-env-doc-sync branch from f37f1bb to 9ce8fec Compare September 18, 2026 14:39
@HouMinXi

Copy link
Copy Markdown
Contributor Author

Rebased onto current release/v3.8.51 (36493a6270). Unique commits unchanged.

diegosouzapw#14022 already documented OMNIROUTE_STRIP_SYSTEM_PREAMBLE and
allowlisted COMBO_LOOP_SAFETY_TIMEOUT_MS. The remaining mismatch is
the ENVIRONMENT.md sentence that still backticks the constant as if
it were operator-facing.

Signed-off-by: Minxi Hou <houminxi@gmail.com>
@HouMinXi
HouMinXi force-pushed the fix/14004-env-doc-sync branch from 9ce8fec to 43952e6 Compare September 20, 2026 15:28
@diegosouzapw

Copy link
Copy Markdown
Owner

Thanks @HouMinXi — merging via the release merge-train. Validated in local merge-train (mt-train10c) on the devbox @ train tip 4d841aa1c740bbaa03868dc0a403c62099a99a42 with the 72 sibling PRs of this batch: typecheck:core, file-size, complexity, cognitive-complexity, changelog-integrity green; changed-area node:test 831/831 (0 failing) and vitest 480/482 — the two reds are autoCombo/provider-family-combos.test.ts timing out at 20s, which reproduces on the PURE release tip under the full vitest suite (and is already tracked by the Release-Green issue #13866), so it is inherited, not this batch's. Merged --admin per merge-gates §3/§4/§7.

@diegosouzapw
diegosouzapw merged commit d46d4d8 into diegosouzapw:release/v3.8.51 Sep 22, 2026
10 of 13 checks passed
@HouMinXi
HouMinXi deleted the fix/14004-env-doc-sync branch September 24, 2026 08:05
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