Skip to content

Fix shell variable expansion in the catalog creation example - #6140

Open
flyrain wants to merge 1 commit into
apache:mainfrom
flyrain:yf/docs-190-create-catalog-cli
Open

flyrain wants to merge 1 commit into
apache:mainfrom
flyrain:yf/docs-190-create-catalog-cli

Conversation

@flyrain

@flyrain flyrain commented Nov 19, 2026 •

Copy link
Copy Markdown
Contributor

The example joins four variable assignments and the polaris invocation into one shell command. Bash expands the arguments before those assignments take effect. A reader starting with a clean shell therefore passes missing values. The example now assigns each variable before invoking the CLI and quotes the arguments.

Ran the example in clean Bash and checked all 13 arguments, including the client ID, catalog name, warehouse URI and role ARN.

Verification build

Checklist

  • The change concerns public documentation.
  • The reason for the correction is described above.
  • The verification is described above.
  • No complex implementation logic needs comments.
  • This correction to documented behavior needs no changelog entry.
  • The change updates the unreleased documentation or its source.

AI assistance was used to prepare and check this change.

@flyrain
flyrain changed the base branch from versioned-docs to main November 19, 2026 03:23
@flyrain
flyrain force-pushed the yf/docs-190-create-catalog-cli branch from 2c03930 to a3806f5 Compare November 19, 2026 03:23
@flyrain flyrain changed the title Fix shell variable expansion in the 1.9.0 catalog creation example Fix shell variable expansion in the catalog creation example Nov 19, 2026
@flyrain
flyrain marked this pull request as ready for review November 19, 2026 04:30
Copilot AI balanced review requested due to automatic review settings November 19, 2026 04:30

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🟢 Approval recommended

No active review issues are recorded for the catalog-creation documentation update.

No open issues 🎉

What changed in this PR

Updates the unreleased catalog-creation guide to avoid premature shell variable expansion and preserve argument boundaries in the CLI example.

Changes:

  • Separates the four variable assignments from the polaris invocation.
  • Quotes credential and storage argument expansions so each value remains a single argument.
File Description
site/​content/​in-dev/​unreleased/​getting-started/​creating-a-catalog/​_index.md Corrects assignment order and argument quoting in the catalog-creation example.

Review effort: Balanced

@ayushtkn ayushtkn left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanx @flyrain for the fix, Changes LGTM

Two more in the same directory, probably worth a follow-up:

catalog-gcs.md has exactly the same bug — CLIENT_ID=root \ through SERVICE_ACCOUNT=... \ followed by polaris .

catalog-azure.md is a different case. Its assignments also end in backslashes, but the last one, CONSENT_URL=..., has none, so the statement ends there with no command word and the variables land in the current shell. That example happens to work, entirely because of the missing backslash. Normalising it to the same form would make it not depend on that.

@github-project-automation github-project-automation Bot moved this from PRs In Progress to Ready to merge in Basic Kanban Board Nov 19, 2026

This branch has not been deployed

No deployments
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.

3 participants