Repository navigation
docs(env): add DEEP_HEALTH_CHECK_ENABLED to .env.example - #14685
Closed
gonisulaimann wants to merge 1 commit into
Closed
gonisulaimann wants to merge 1 commit into
gonisulaimann wants to merge 1 commit into
Conversation
The opt-in deep health check flag shipped in diegosouzapw#14236 but only ever existed in code; check-env-doc-sync now fails on the release tip because the var is referenced in src/app/api/monitoring/health/route.ts and absent from .env.example. Document it next to the healthcheck-path block and mirror the row in ENVIRONMENT.md (the sync check reads both). Verified: npm run check:env-doc-sync and npm run check:docs-all pass on this tree; both fail on the release tip without the change.
Contributor
Author
|
Closing in favor of #14683, which covers the same DEEP_HEALTH_CHECK_ENABLED contract gap in both .env.example and docs/reference/ENVIRONMENT.md alongside the other release-quality repairs. No point carrying a duplicate. |
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.
Why
npm run check:docs-allfails on the currentrelease/v3.8.51tip — the env-contract sync reports one var in code but missing from.env.example:The flag ships with #14236 (opt-in
?deep=1completions sampling on/api/monitoring/health) but was never added to the env surface docs, and the sync gate reads both.env.exampleanddocs/reference/ENVIRONMENT.md.What
.env.example: documentDEEP_HEALTH_CHECK_ENABLED(commented example, default off) next to theOMNIROUTE_HEALTHCHECK_PATHblock it belongs with.docs/reference/ENVIRONMENT.md: one matching row pointing atsrc/app/api/monitoring/health/route.tsand the?deep=1behavior.No code change — the flag itself already behaves exactly as #14236 specified.
Verification
npm run check:env-doc-syncnpm run check:docs-allRefs #14547 (docs-gates slice of the base-red).