-
Notifications
You must be signed in to change notification settings - Fork 98
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
chore: update issue templates and codeowners
chore: update issue templates and codeowners Source-Link: googleapis/synthtool@bf182cd Post-Processor: gcr.io/cloud-devrel-public-resources/owlbot-nodejs:latest@sha256:a5af6af827a9fffba373151e1453b0498da288024cdd16477900dd42857a42e0
- Loading branch information
1 parent
78fde86
commit 695de0d
Showing
15 changed files
with
435 additions
and
12 deletions.
There are no files selected for viewing
This file contains 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
Validating CODEOWNERS rules …
This file contains 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
This file contains 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
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 https://issuetracker.google.com/savedsearches/559776 | ||
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 |
This file contains 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
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](https://issuetracker.google.com/savedsearches/559776)). | ||
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 contains 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
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](https://issuetracker.google.com/savedsearches/559776)) | ||
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 |
This file contains 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
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 contains 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
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//discussions) | ||
to engage with fellow community members! |
This file contains 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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,3 +1,2 @@ | ||
processes: | ||
- "NodeDependency" | ||
- "OwlBotTemplateChanges" | ||
- "NodeDependency" |
This file contains 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
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); | ||
} | ||
} | ||
}; |
This file contains 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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,69 @@ | ||
// 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. | ||
|
||
function labeledEvent(data) { | ||
return data.event === 'labeled' && data.label.name === 'needs more info'; | ||
} | ||
|
||
const numberOfDaysLimit = 15; | ||
const close_message = `This has been closed since a request for information has \ | ||
not been answered for ${numberOfDaysLimit} days. It can be reopened when the \ | ||
requested information is provided.`; | ||
|
||
module.exports = async ({github, context}) => { | ||
const owner = context.repo.owner; | ||
const repo = context.repo.repo; | ||
|
||
const issues = await github.rest.issues.listForRepo({ | ||
owner: owner, | ||
repo: repo, | ||
labels: 'needs more info', | ||
}); | ||
const numbers = issues.data.map((e) => e.number); | ||
|
||
for (const number of numbers) { | ||
const events = await github.paginate( | ||
github.rest.issues.listEventsForTimeline, | ||
{ | ||
owner: owner, | ||
repo: repo, | ||
issue_number: number, | ||
}, | ||
(response) => response.data.filter(labeledEvent) | ||
); | ||
|
||
const latest_response_label = events[events.length - 1]; | ||
|
||
const created_at = new Date(latest_response_label.created_at); | ||
const now = new Date(); | ||
const diff = now - created_at; | ||
const diffDays = diff / (1000 * 60 * 60 * 24); | ||
|
||
if (diffDays > numberOfDaysLimit) { | ||
await github.rest.issues.update({ | ||
owner: owner, | ||
repo: repo, | ||
issue_number: number, | ||
state: 'closed', | ||
}); | ||
|
||
await github.rest.issues.createComment({ | ||
owner: owner, | ||
repo: repo, | ||
issue_number: number, | ||
body: close_message, | ||
}); | ||
} | ||
} | ||
}; |
Oops, something went wrong.