fix(docs): restore the env/docs contract broken by the #13679 vars - #13875
Merged
diegosouzapw merged 1 commit intoSep 16, 2026
Merged
Conversation
`check:env-doc-sync` is failing on the release tip, which fails "Docs Gates (fast-path)" on every open PR against release/v3.8.51 (base-red #13866). Both gaps come from #13679: - `OMNIROUTE_CLOUD_SYNC_ENFORCE_SIGNATURE` is read in src/lib/cloudSync.ts but was in neither .env.example nor ENVIRONMENT.md. Documented with the behaviour the code actually implements: opt-in rejection of an UNSIGNED response when no local secret is configured, default off for v3.8.x back-compat, and a present signature always verified — and always rejected when OMNIROUTE_CLOUD_SYNC_SECRET is unset — regardless of the flag. - `CDP_PROXY_TOKEN` was in .env.example but missing from ENVIRONMENT.md. Added to the ChatGPT Web (Codex) table next to CHATGPT_WEB_CODEX_CDP_URL, in that section's language, describing the X-Omni-Cdp-Token header the sidecar expects and the compose-network isolation that applies when it is unset. Docs only, no code change. Verified on this branch: check:env-doc-sync reports all three directions in sync (817 vars in .env.example, 834 in ENVIRONMENT.md); check:docs-sync passes; check:docs-counts reports only pre-existing soft drift.
muhamadgalihsaputra
pushed a commit
to niyatna/NiyatnaRoute
that referenced
this pull request
Sep 27, 2026
…3679 vars (diegosouzapw#13875) `check:env-doc-sync` is failing on the release tip, which fails "Docs Gates (fast-path)" on every open PR against release/v3.8.51 (base-red diegosouzapw#13866). Both gaps come from diegosouzapw#13679: - `OMNIROUTE_CLOUD_SYNC_ENFORCE_SIGNATURE` is read in src/lib/cloudSync.ts but was in neither .env.example nor ENVIRONMENT.md. Documented with the behaviour the code actually implements: opt-in rejection of an UNSIGNED response when no local secret is configured, default off for v3.8.x back-compat, and a present signature always verified — and always rejected when OMNIROUTE_CLOUD_SYNC_SECRET is unset — regardless of the flag. - `CDP_PROXY_TOKEN` was in .env.example but missing from ENVIRONMENT.md. Added to the ChatGPT Web (Codex) table next to CHATGPT_WEB_CODEX_CDP_URL, in that section's language, describing the X-Omni-Cdp-Token header the sidecar expects and the compose-network isolation that applies when it is unset. Docs only, no code change. Verified on this branch: check:env-doc-sync reports all three directions in sync (817 vars in .env.example, 834 in ENVIRONMENT.md); check:docs-sync passes; check:docs-counts reports only pre-existing soft drift.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Clears the HARD failure in base-red #13866.
check:env-doc-syncfails on the release tip, whichturns "Docs Gates (fast-path)" red on every open PR against
release/v3.8.51— the same sevenchecks currently red on #13831 and #13868 come from here.
Both gaps were introduced by #13679:
OMNIROUTE_CLOUD_SYNC_ENFORCE_SIGNATUREsrc/lib/cloudSync.ts, absent from.env.exampleandENVIRONMENT.mdCDP_PROXY_TOKEN.env.example, absent fromENVIRONMENT.mdThe descriptions follow the code, not the variable name:
signature that IS present is always verified, and always rejected when
OMNIROUTE_CLOUD_SYNC_SECRETis unset, whatever the flag says. Default off for v3.8.x back-compat; v3.9 flips it.
CDP_PROXY_TOKENis theX-Omni-Cdp-Tokenthe CDP proxy sidecar requires when set; unset, theproxy forwards unauthenticated and the compose network
chatgpt-web-codex-netis the mitigation.Docs only — no code change.
Validation
check:env-doc-sync.env.example, 834 inENVIRONMENT.md)check:docs-synccheck:docs-countsNote:
.env.examplehas no Prettier parser, so it is not covered by the format gate.