Skip to content

feat(commandsgen): generate CLI environment variables docs index - #1138

Open
sornapudisuresh wants to merge 1 commit into
temporalio:mainfrom
sornapudisuresh:feat/697-env-var-docs-index
Open

feat(commandsgen): generate CLI environment variables docs index#1138
sornapudisuresh wants to merge 1 commit into
temporalio:mainfrom
sornapudisuresh:feat/697-env-var-docs-index

Conversation

@sornapudisuresh

Copy link
Copy Markdown

Summary

  • Extends gen-docs to emit environment-variables.mdx from implied-env options (alphabetized env var → flag → description).
  • Adds a tip distinguishing shell env vars from temporal env presets.
  • Documents special cases: TEMPORAL_GRPC_META_* and legacy TLS variables.
  • Skips the page when -subdir is used so cloud-cli docs generation does not overwrite it.
  • Closes Create an index of environment variables for the docs site #697

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/docs and inspect dist/docs/environment-variables.mdx

Emit alphabetized environment-variables.mdx from implied-env options,
plus special cases for TEMPORAL_GRPC_META_* and legacy TLS vars.

Fixes temporalio#697
@sornapudisuresh
sornapudisuresh requested a review from a team as a code owner July 27, 2026 18:29
@CLAassistant

CLAassistant commented Jul 27, 2026

Copy link
Copy Markdown

CLA assistant check
All committers have signed the CLA.

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.

Create an index of environment variables for the docs site

2 participants