Repository navigation
Conversation
Contributor
There was a problem hiding this comment.
Code Review
This pull request updates the legacy installation instructions in the README files to use a static npm command instead of a template variable. Additionally, it introduces a dedicated npmRegistry Gaxios instance for querying npm and refactors the HTTP status handling in bin/generate-readme.mjs. Feedback on the changes notes that because validateStatus: () => true is configured, HTTP errors like 404 will not be thrown, rendering the 404 checks inside the catch block unreachable dead code that can be simplified.
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
Updates HTTP client checks in
generate-readme.mjsand workflow schedule settings.Impact
Fixes support URL fallback checks and reduces scheduled workflow runs.
Changes
Gaxiosclient with retry configuration forregistry.npmjs.orgpackage lookups inbin/generate-readme.mjs.res.status === 404when probingsupportDocsUrlwithvalidateStatus: () => trueso missing Getting Support pages fall back toproduct_documentation.{{ metadata['lib_install_cmd'] }}placeholder inbin/README.mustacheand regenerateREADME.md.name,concurrency,timeout-minutes: 15, and a weekly cron schedule to.github/workflows/update-api-list.yaml.Testing
node --check bin/generate-readme.mjs..github/workflows/update-api-list.yamlYAML syntax.Alternatives
validateStatus: () => truewithout checkingres.statusruns unnecessary daily jobs and skips the support link fallback on 404 responses.