Skip to content

fix(help): add private package name and fix docs-devsite vars - #9914

Draft
quirogas wants to merge 1 commit into
googleapis:mainfrom
quirogas:fix/core-help-package-and-docs-script
Draft

quirogas wants to merge 1 commit into
googleapis:mainfrom
quirogas:fix/core-help-package-and-docs-script

Conversation

@quirogas

Copy link
Copy Markdown
Contributor

Description

Adds package metadata to core/help and fixes shell variable references.

Impact

Prevents accidental publishing and fixes path quoting in docs generation.

Changes

  • Add "name": "@google-cloud/help" and "private": true to core/help/package.json.
  • Fix undefined $ABS_DIR reference in core/help/docs-devsite.sh (using $DOCS_DIR), quote path expansions, and iterate directly over "$ROOT_DIR"/docs/*.md.

Testing

  • Validated core/help/package.json JSON syntax and checked core/help/docs-devsite.sh with bash -n.

Alternatives

  • Leaving core/help/package.json without "name" and "private": true leaves an unnamed workspace package and risks undefined path behavior in docs-devsite.sh.

@gemini-code-assist gemini-code-assist Bot 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.

Code Review

This pull request updates core/help/docs-devsite.sh to improve shell scripting practices, including quoting variables to prevent word splitting, correcting an undefined variable reference, and replacing an ls command substitution with a direct glob in the for loop. It also updates core/help/package.json to define the package name and mark it as private. There are no review comments, and we have no additional feedback to provide.

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.

1 participant