feat(commandsgen): generate CLI environment variables docs index - #1138
Open
sornapudisuresh wants to merge 3 commits into
Open
feat(commandsgen): generate CLI environment variables docs index#1138sornapudisuresh wants to merge 3 commits into
sornapudisuresh wants to merge 3 commits into
Conversation
Emit alphabetized environment-variables.mdx from implied-env options, plus special cases for TEMPORAL_GRPC_META_* and legacy TLS vars. Fixes temporalio#697
|
|
TEMPORAL_ENV and TEMPORAL_ENV_FILE configure the `temporal env` preset system, which stores named key-value presets in temporal.yaml. Listing them in the main table alongside TEMPORAL_PROFILE and TEMPORAL_CONFIG_FILE presented two different config systems as peers, and contradicted the note telling readers not to conflate shell variables with `temporal env` presets. Move both into a "Legacy temporal env variables" section under Special cases, mirroring the existing legacy TLS section, and reword the intro to state the relationship instead of denying it.
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
3 participants
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.
Summary
gen-docsto emitenvironment-variables.mdxfromimplied-envoptions (alphabetized env var → flag → description).temporal envpresets.TEMPORAL_GRPC_META_*and legacy TLS variables.-subdiris used so cloud-cli docs generation does not overwrite it.Test plan
go test ./internal/commandsgen/ ./cmd/gen-docs/go test ./...go run ./cmd/gen-docs -input internal/temporalcli/commands.yaml -input cliext/option-sets.yaml -output dist/docsand inspectdist/docs/environment-variables.mdx