Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

owlbot-nodejs creates READMEs with broken links #1121

Closed
SurferJeffAtGoogle opened this issue Jun 16, 2021 · 5 comments
Closed

owlbot-nodejs creates READMEs with broken links #1121

SurferJeffAtGoogle opened this issue Jun 16, 2021 · 5 comments
Labels
lang: nodejs Issues specific to JavaScript or TypeScript. priority: p2 Moderately-important priority. Fix may not be included in next release. 🚨 This issue needs some love. type: bug Error or flaw in code with unintended results or allowing sub-optimal usage patterns.

Comments

@SurferJeffAtGoogle
Copy link
Contributor

As seen in googleapis/nodejs-storage#1310

The Owl Bot nodejs post processor created links to the new samples. However, because the PR was not yet merged, the links were actually broken. The docs check failed and @shaffeeullah was prevented from merging the pull request.

This will be a common situation. We must provide a common solution so that repo maintainers do not have to contact Yoshi team every time they add a sample.
@SurferJeffAtGoogle SurferJeffAtGoogle added type: bug Error or flaw in code with unintended results or allowing sub-optimal usage patterns. priority: p2 Moderately-important priority. Fix may not be included in next release. labels Jun 16, 2021
@tmatsuo tmatsuo added snippet-bot:no-prefix-req Instruct snippet-bot to ignore prefix requirement and removed snippet-bot:no-prefix-req Instruct snippet-bot to ignore prefix requirement labels Jun 16, 2021
@tmatsuo
Copy link
Contributor

tmatsuo commented Jun 16, 2021

FWIW, snippet-bot has a label snippet-bot:no-prefix-req for ignoring a certain type of check.
I'm not sure how the link checker is implemented, but introducing a flag for ignoring an error, might work for many cases.

@SurferJeffAtGoogle
Copy link
Contributor Author

SurferJeffAtGoogle commented Jun 21, 2021 •
edited
Loading

@shaffeeullah, next time this happens, add the label owlbot:ignore to your pull request and Owl Bot will stop updating it.

@busunkim96 busunkim96 added the lang: nodejs Issues specific to JavaScript or TypeScript. label Sep 1, 2021
@yoshi-automation yoshi-automation added 🚨 This issue needs some love. and removed 🚨 This issue needs some love. labels Nov 30, 2021
@sofisl
Copy link
Contributor

sofisl commented Dec 13, 2021

This issue is going OOSLO soon.

@shaffeeullah
Copy link

i think this has been fixed? at least in storage. @bcoe did something to fix it.

@yoshi-automation yoshi-automation added the 🚨 This issue needs some love. label Dec 13, 2021
@SurferJeffAtGoogle
Copy link
Contributor Author

Let's call it fixed. Please re-open if we see it again.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
lang: nodejs Issues specific to JavaScript or TypeScript. priority: p2 Moderately-important priority. Fix may not be included in next release. 🚨 This issue needs some love. type: bug Error or flaw in code with unintended results or allowing sub-optimal usage patterns.
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
6 participants
@tmatsuo @busunkim96 @SurferJeffAtGoogle @shaffeeullah @yoshi-automation @sofisl