Repository navigation
Conversation
Contributor
There was a problem hiding this comment.
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
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.
Description
Adds package metadata to
core/helpand fixes shell variable references.Impact
Prevents accidental publishing and fixes path quoting in docs generation.
Changes
"name": "@google-cloud/help"and"private": truetocore/help/package.json.$ABS_DIRreference incore/help/docs-devsite.sh(using$DOCS_DIR), quote path expansions, and iterate directly over"$ROOT_DIR"/docs/*.md.Testing
core/help/package.jsonJSON syntax and checkedcore/help/docs-devsite.shwithbash -n.Alternatives
core/help/package.jsonwithout"name"and"private": trueleaves an unnamed workspace package and risks undefined path behavior indocs-devsite.sh.