Repository navigation
ci: retire the env-vars generator from update-ref-docs - #674
Merged
Merged
Conversation
kagent#3434 deleted docs/env.md at v1.0.0-rc1 and declared environment variables internal wiring rather than a supported interface. The "Generate environment variable reference" step exits 1 when that file is missing, so every rc1 reference-docs run fails until it is removed. Remove the step, the WITH_ENV_DOCS and KAGENT_ENV_PAGE plumbing, the ENV_DOCS_NOTE in the generated PR body, and scripts/generate-env-docs.py. The helm.md write step now carries over an existing aliases: block from the page it overwrites. The 1.x env-vars page is deleted in the alpha18 docs PR (#652) with an alias on reference/helm.md, and without this the next regeneration would drop that alias and 404 the old URL. Signed-off-by: Rachael Graham <rachael.graham@solo.io> Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com>
Contributor
Docs preview
Both are uploaded Worker versions and serve no production traffic. |
kristin-kronstain-brown
approved these changes
Nov 2, 2026
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
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.
Split out of #652 so that the rc1 reference-docs run can succeed before #652 merges, as requested in review.
Retires the env-vars generator. kagent#3434 deleted
docs/env.mdat v1.0.0-rc1 and declared environment variables internal wiring, not a supported interface. The "Generate environment variable reference" step exits 1 when that file is missing, so every rc1 run fails today. This PR removes the step, itsWITH_ENV_DOCSandKAGENT_ENV_PAGEplumbing, the env note in the generated PR body, andscripts/generate-env-docs.py. The env-vars page itself is deleted in #652.Keeps aliases on the Helm reference. The helm.md write step now carries over an existing
aliases:block. #652 redirects the retired env-vars URL with an alias onreference/helm.md, and the next regeneration would otherwise drop it.Worth a close look: the
awkthat extracts the aliases block. It reads only the frontmatter, and it emits nothing when the page has no aliases, so 0.x output is unchanged.Merge this first, run the reference-docs workflow at
v1.0.0-rc1, then merge #652.TEST RUN: https://github.com/kagent-dev/website/pull/675/files