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.

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

Node library bug-report.md template does not generate product name. #1506

Open
loferris opened this issue Jul 22, 2022 · 0 comments
Open

Node library bug-report.md template does not generate product name. #1506

loferris opened this issue Jul 22, 2022 · 0 comments
Labels
lang: nodejs Issues specific to JavaScript or TypeScript. priority: p3 Desirable enhancement or fix. May not be included in next release. type: bug Error or flaw in code with unintended results or allowing sub-optimal usage patterns.

Comments

@loferris
Copy link
Contributor

Thanks for stopping by to let us know something could be better!

PLEASE READ: If you have a support contract with Google, please create an issue in the support console instead of filing on GitHub. This will ensure a timely response.

Is your feature request related to a problem? Please describe.
In handwritten libraries, such as nodejs-pubsub, nodejs-bigquery, and nodejs-bigquery-storage, the .github/ISSUE_TEMPLATES/bug-report.md template does not capture the correct metadata to autogenerate the product name. This leads to an obvious typo in downstream repos, and has led to at least one customer issue, which I resolved by manually changing it and excluding the file from owlbot updates, which is not ideal.
Describe the solution you'd like
I want the variable in the bug-template.md to populate the correct product name in downstream repos.
Describe alternatives you've considered
An alternative I implemented as a stop-gap was to manually fix the template in nodejs-bigquery and add the file to a list that owlbot updates excludes.
Additional context
Add any other context or screenshots about the feature request here.
I have also determined that this error is happening in auto-generated libraries as well, making it more pressing that this error be resolved at the synthtool level and make manual changes to owlbot configurations less necessary.
I also think it would make sense to audit other Node templates in synthtool to make sure this same error doesn't repeat elsewhere, so we can fix any issues at once.
I'm also wondering why the Node template differs from the Python and Java templates.

@loferris loferris self-assigned this Jul 22, 2022
@tmatsuo tmatsuo 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 Jul 25, 2022
@chingor13 chingor13 added the lang: nodejs Issues specific to JavaScript or TypeScript. label Jul 25, 2022
@loferris loferris added priority: p3 Desirable enhancement or fix. May not be included in next release. and removed priority: p2 Moderately-important priority. Fix may not be included in next release. labels Oct 25, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
lang: nodejs Issues specific to JavaScript or TypeScript. priority: p3 Desirable enhancement or fix. May not be included in next release. type: bug Error or flaw in code with unintended results or allowing sub-optimal usage patterns.
Projects
None yet
Development

No branches or pull requests

3 participants