-
Notifications
You must be signed in to change notification settings - Fork 85
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
chore: update issue templates and codeowners #1993
Changes from all commits
ddabba9
7622ce9
4d3b5f5
16e9e44
77c9c38
1029e6e
26ae44e
61701a2
344d771
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
This file was deleted.
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,99 @@ | ||
name: Bug Report | ||
description: Create a report to help us improve | ||
labels: | ||
- bug | ||
body: | ||
- type: markdown | ||
attributes: | ||
value: > | ||
**PLEASE READ**: If you have a support contract with Google, please | ||
create an issue in the [support | ||
console](https://cloud.google.com/support/) instead of filing on GitHub. | ||
This will ensure a timely response. Otherwise, please make sure to | ||
follow the steps below. | ||
- type: checkboxes | ||
attributes: | ||
label: Please make sure you have searched for information in the following | ||
guides. | ||
options: | ||
- label: "Search the issues already opened: | ||
https://github.com/GoogleCloudPlatform/google-cloud-node/issues" | ||
required: true | ||
- label: "Search StackOverflow: | ||
http://stackoverflow.com/questions/tagged/google-cloud-platform+nod\ | ||
e.js" | ||
required: true | ||
- label: "Check our Troubleshooting guide: | ||
https://googlecloudplatform.github.io/google-cloud-node/#/docs/guid\ | ||
es/troubleshooting" | ||
required: true | ||
- label: "Check our FAQ: | ||
https://googlecloudplatform.github.io/google-cloud-node/#/docs/guid\ | ||
es/faq" | ||
required: true | ||
- label: "Check our libraries HOW-TO: | ||
https://github.com/googleapis/gax-nodejs/blob/main/client-libraries\ | ||
.md" | ||
required: true | ||
- label: "Check out our authentication guide: | ||
https://github.com/googleapis/google-auth-library-nodejs" | ||
required: true | ||
- label: "Check out handwritten samples for many of our APIs: | ||
https://github.com/GoogleCloudPlatform/nodejs-docs-samples" | ||
required: true | ||
- type: textarea | ||
attributes: | ||
label: > | ||
A screenshot that you have tested with "Try this API". | ||
description: > | ||
As our client libraries are mostly autogenerated, we kindly request | ||
that you test whether your issue is with the client library, or with the | ||
API itself. To do so, please search for your API | ||
here: https://developers.google.com/apis-explorer and attempt to | ||
reproduce the issue in the given method. Please include a screenshot of | ||
the response in "Try this API". This response should NOT match the current | ||
behavior you are experiencing. If the behavior is the same, it means | ||
that you are likely experiencing a bug with the API itself. In that | ||
case, please submit an issue to the API team, either by submitting an | ||
issue in its issue tracker https://cloud.google.com/support/docs/issue-trackers, or by | ||
submitting an issue in its linked tracker in the .repo-metadata.json | ||
file {{ metadata['repo']['issue_tracker'] }} | ||
validations: | ||
required: true | ||
- type: input | ||
attributes: | ||
label: > | ||
Link to the code that reproduces this issue. A link to a **public** Github Repository or gist with a minimal | ||
reproduction. | ||
description: > | ||
**Skipping this or providing an invalid link will result in the issue being closed** | ||
validations: | ||
required: true | ||
- type: textarea | ||
attributes: | ||
label: > | ||
A step-by-step description of how to reproduce the issue, based on | ||
the linked reproduction. | ||
description: > | ||
Screenshots can be provided in the issue body below. | ||
placeholder: | | ||
1. Start the application in development (next dev) | ||
2. Click X | ||
3. Y will happen | ||
validations: | ||
required: true | ||
- type: textarea | ||
attributes: | ||
label: A clear and concise description of what the bug is, and what you | ||
expected to happen. | ||
placeholder: Following the steps from the previous section, I expected A to | ||
happen, but I observed B instead | ||
validations: | ||
required: true | ||
|
||
- type: textarea | ||
attributes: | ||
label: A clear and concise description WHY you expect this behavior, i.e., was it a recent change, there is documentation that points to this behavior, etc. ** | ||
placeholder: 'Documentation here(link) states that B should happen instead of A' | ||
validations: | ||
required: true |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,53 @@ | ||
name: Documentation Requests | ||
description: Requests for more information | ||
body: | ||
- type: markdown | ||
attributes: | ||
value: > | ||
Please use this issue type to log documentation requests against the library itself. | ||
These requests should involve documentation on Github (`.md` files), and should relate to the library | ||
itself. If you have questions or documentation requests for an API, please | ||
reach out to the API tracker itself. | ||
|
||
Please submit an issue to the API team, either by submitting an | ||
issue in its issue tracker https://cloud.google.com/support/docs/issue-trackers), or by | ||
submitting an issue in its linked tracker in the .repo-metadata.json | ||
file in the API under packages/* ([example]({{ metadata['repo']['issue_tracker'] }})). | ||
You can also submit a request to documentation on cloud.google.com itself with the "Send Feedback" | ||
on the bottom of the page. | ||
|
||
|
||
Please note that documentation requests and questions for specific APIs | ||
will be closed. | ||
- type: checkboxes | ||
attributes: | ||
label: Please make sure you have searched for information in the following | ||
guides. | ||
options: | ||
- label: "Search the issues already opened: | ||
https://github.com/GoogleCloudPlatform/google-cloud-node/issues" | ||
required: true | ||
- label: "Check our Troubleshooting guide: | ||
https://googlecloudplatform.github.io/google-cloud-node/#/docs/guid\ | ||
es/troubleshooting" | ||
required: true | ||
- label: "Check our FAQ: | ||
https://googlecloudplatform.github.io/google-cloud-node/#/docs/guid\ | ||
es/faq" | ||
required: true | ||
- label: "Check our libraries HOW-TO: | ||
https://github.com/googleapis/gax-nodejs/blob/main/client-libraries\ | ||
.md" | ||
required: true | ||
- label: "Check out our authentication guide: | ||
https://github.com/googleapis/google-auth-library-nodejs" | ||
required: true | ||
- label: "Check out handwritten samples for many of our APIs: | ||
https://github.com/GoogleCloudPlatform/nodejs-docs-samples" | ||
required: true | ||
- type: textarea | ||
attributes: | ||
label: > | ||
Documentation Request | ||
validations: | ||
required: true |
This file was deleted.
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,53 @@ | ||
name: Feature Request | ||
description: Suggest an idea for this library | ||
labels: | ||
- feature request | ||
body: | ||
- type: markdown | ||
attributes: | ||
value: > | ||
**PLEASE READ**: If you have a support contract with Google, please | ||
create an issue in the [support | ||
console](https://cloud.google.com/support/) instead of filing on GitHub. | ||
This will ensure a timely response. Otherwise, please make sure to | ||
follow the steps below. | ||
- type: textarea | ||
attributes: | ||
label: > | ||
A screenshot that you have tested with "Try this API". | ||
description: > | ||
As our client libraries are mostly autogenerated, we kindly request | ||
that you test whether your feature request is with the client library, or with the | ||
API itself. To do so, please search for your API | ||
here: https://developers.google.com/apis-explorer and attempt to | ||
reproduce the issue in the given method. Please include a screenshot of | ||
the response in "Try this API". This response should NOT match the current | ||
behavior you are experiencing. If the behavior is the same, it means | ||
that you are likely requesting a feature for the API itself. In that | ||
case, please submit an issue to the API team, either by submitting an | ||
issue in its issue tracker https://cloud.google.com/support/docs/issue-trackers, or by | ||
submitting an issue in its linked tracker in the .repo-metadata.json | ||
file in the API under packages/* ([example]({{ metadata['repo']['issue_tracker'] }})) | ||
|
||
Example of library specific issues would be: retry strategies, authentication questions, or issues with typings. | ||
Examples of API issues would include: expanding method parameter types, adding functionality to an API. | ||
validations: | ||
required: true | ||
- type: textarea | ||
attributes: | ||
label: > | ||
What would you like to see in the library? | ||
description: > | ||
Screenshots can be provided in the issue body below. | ||
placeholder: | | ||
1. Set up authentication like so | ||
2. Run the program like so | ||
3. X would be nice to happen | ||
|
||
- type: textarea | ||
attributes: | ||
label: Describe alternatives you've considered | ||
|
||
- type: textarea | ||
attributes: | ||
label: Additional context/notes |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,5 @@ | ||
--- | ||
name: Process Request | ||
about: Submit a process request to the library. Process requests are any requests related to library infrastructure, including CI/CD, publishing, releasing, etc. This issue template should primarily used by internal members. | ||
|
||
--- |
This file was deleted.
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,8 @@ | ||
--- | ||
name: Question | ||
about: If you have a question, please use Discussions | ||
|
||
--- | ||
|
||
If you have a general question that goes beyond the library itself, we encourage you to use [Discussions](https://github.com/{{ metadata['repo']['repository'] }}/discussions) | ||
to engage with fellow community members! |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,4 +1,2 @@ | ||
processes: | ||
- "NodeDependency" | ||
- "OwlBotTemplateChangesNode" | ||
- "OwlBotPRsNode" | ||
- "NodeDependency" | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. request for yaml not yml to be consistent There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. I don't think I should change this one: https://github.com/googleapis/repo-automation-bots/blob/bc1194c1fe6f08803f64cb847809c8692a955854/packages/auto-approve/src/auto-approve.ts#L45 There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Is it possible we could use .yml for the others above? There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. +1 that's fine too |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,53 @@ | ||
// Copyright 2024 Google LLC | ||
// | ||
// Licensed under the Apache License, Version 2.0 (the "License"); | ||
// you may not use this file except in compliance with the License. | ||
// You may obtain a copy of the License at | ||
// | ||
// http://www.apache.org/licenses/LICENSE-2.0 | ||
// | ||
// Unless required by applicable law or agreed to in writing, software | ||
// distributed under the License is distributed on an "AS IS" BASIS, | ||
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
// See the License for the specific language governing permissions and | ||
// limitations under the License. | ||
|
||
async function closeIssue(github, owner, repo, number) { | ||
await github.rest.issues.createComment({ | ||
owner: owner, | ||
repo: repo, | ||
issue_number: number, | ||
body: 'Issue was opened with an invalid reproduction link. Please make sure the repository is a valid, publicly-accessible github repository, and make sure the url is complete (example: https://github.com/googleapis/google-cloud-node)' | ||
}); | ||
await github.rest.issues.update({ | ||
owner: owner, | ||
repo: repo, | ||
issue_number: number, | ||
state: 'closed' | ||
}); | ||
} | ||
module.exports = async ({github, context}) => { | ||
const owner = context.repo.owner; | ||
const repo = context.repo.repo; | ||
const number = context.issue.number; | ||
|
||
const issue = await github.rest.issues.get({ | ||
owner: owner, | ||
repo: repo, | ||
issue_number: number, | ||
}); | ||
|
||
const isBugTemplate = issue.data.body.includes('Link to the code that reproduces this issue'); | ||
|
||
if (isBugTemplate) { | ||
try { | ||
const link = issue.data.body.split('\n')[18].match(/(https?:\/\/g?i?s?t?\.?github.com\/.*)/); | ||
const isValidLink = (await fetch(link)).ok; | ||
if (!isValidLink) { | ||
await closeIssue(github, owner, repo, number); | ||
} | ||
} catch (err) { | ||
await closeIssue(github, owner, repo, number); | ||
} | ||
} | ||
}; |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I see that most of the others were changed from markdown -> yaml - should this one be also?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Nope! It doesn't have any input fields.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I could see that, but there might also be some value in just making them consistent for later edits.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'm going to keep it as is to discourage api-specific questions, see: https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/common-validation-errors-when-creating-issue-forms#body-must-contain-at-least-one-non-markdown-field