chore: update links in github issue templates (#825)

gcf-owl-bot[bot] · sofisl · web-flow · commit 1ab0344ff3fb · 2024-10-23T16:55:44.000-04:00
* chore: update links in github issue templates * chore: update links in github issue templates Source-Link: googleapis/synthtool@38fa49f Post-Processor: gcr.io/cloud-devrel-public-resources/owlbot-nodejs:latest@sha256:609822e3c09b7a1bd90b99655904609f162cc15acb4704f1edf778284c36f429 * Update owlbot.py * Update bug_report.yml * Delete .github/ISSUE_TEMPLATE/feature_request.md * Update feature_request.yml * Delete .github/ISSUE_TEMPLATE/question.md * Delete .github/ISSUE_TEMPLATE/support_request.md * Delete .github/scripts/close-invalid-link.cjs * Delete .github/workflows/issues-no-repro.yaml * Update package.json * Update .repo-metadata.json * Update .jsdoc.js * Update owlbot.py * Update .repo-metadata.json * 🦉 Updates from OwlBot post-processor See https://github.com/googleapis/repo-automation-bots/blob/main/packages/owl-bot/README.md --------- Co-authored-by: Owl Bot <gcf-owl-bot[bot]@users.noreply.github.com> Co-authored-by: sofisl <55454395+sofisl@users.noreply.github.com>
diff --git a/core/common/.github/.OwlBot.lock.yaml b/core/common/.github/.OwlBot.lock.yaml
@@ -13,5 +13,5 @@
 # limitations under the License.
 docker:
   image: gcr.io/cloud-devrel-public-resources/owlbot-nodejs:latest
-  digest: sha256:d920257482ca1cd72978f29f7d28765a9f8c758c21ee0708234db5cf4c5016c2
-# created: 2024-06-12T16:18:41.688792375Z
+  digest: sha256:609822e3c09b7a1bd90b99655904609f162cc15acb4704f1edf778284c36f429
+# created: 2024-10-01T19:34:30.797530443Z
diff --git a/core/common/.github/CODEOWNERS b/core/common/.github/CODEOWNERS
@@ -5,8 +5,5 @@
 # https://help.github.com/en/github/creating-cloning-and-archiving-repositories/about-code-owners#codeowners-syntax
 
 
-# The yoshi-nodejs team is the default owner for nodejs repositories.
-*     @googleapis/yoshi-nodejs
-
-# The github automation team is the default owner for the auto-approve file.
-.github/auto-approve.yml @googleapis/github-automation
+# Unless specified, the jsteam is the default owner for nodejs repositories.
+*     @googleapis/jsteam-handwritten-libraries @googleapis/jsteam
diff --git a/core/common/.github/ISSUE_TEMPLATE/bug_report.yml b/core/common/.github/ISSUE_TEMPLATE/bug_report.yml
@@ -0,0 +1,69 @@
+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://github.com/googleapis/google-cloud-node/blob/main/docs/trou\
+            bleshooting.md"
+          required: true
+        - label: "Check our FAQ:
+            https://github.com/googleapis/google-cloud-node/blob/main/docs/faq.\
+            md"
+          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: input
+    attributes:
+      label: >
+        Link to the code that reproduces this issue. A link to a **public** Github Repository or gist with a minimal
+        reproduction.
+  - 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
+        2. Click X
+        3. Y will happen
+  - 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
+  - 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'
diff --git a/core/common/.github/ISSUE_TEMPLATE/documentation_request.yml b/core/common/.github/ISSUE_TEMPLATE/documentation_request.yml
@@ -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]()).
+        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
diff --git a/core/common/.github/ISSUE_TEMPLATE/feature_request.md b/core/common/.github/ISSUE_TEMPLATE/feature_request.md
diff --git a/core/common/.github/ISSUE_TEMPLATE/feature_request.yml b/core/common/.github/ISSUE_TEMPLATE/feature_request.yml
@@ -0,0 +1,31 @@
+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: >
+        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
diff --git a/core/common/.github/ISSUE_TEMPLATE/processs_request.md b/core/common/.github/ISSUE_TEMPLATE/processs_request.md
@@ -0,0 +1,4 @@
+---
+name: Process Request
+about: Submit a process request to the library. Process requests are any requests related to library infrastructure, for example CI/CD, publishing, releasing, broken links.
+---
diff --git a/core/common/.github/ISSUE_TEMPLATE/question.md b/core/common/.github/ISSUE_TEMPLATE/question.md
diff --git a/core/common/.github/ISSUE_TEMPLATE/questions.md b/core/common/.github/ISSUE_TEMPLATE/questions.md
@@ -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!
diff --git a/core/common/.github/ISSUE_TEMPLATE/support_request.md b/core/common/.github/ISSUE_TEMPLATE/support_request.md
diff --git a/core/common/.github/auto-approve.yml b/core/common/.github/auto-approve.yml
@@ -1,4 +1,2 @@
 processes:
-  - "NodeDependency"
-  - "OwlBotTemplateChangesNode"
-  - "OwlBotPRsNode"
+  - "NodeDependency"
diff --git a/core/common/.github/scripts/close-unresponsive.cjs b/core/common/.github/scripts/close-unresponsive.cjs
@@ -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,
+        });
+      }
+    }
+  };
diff --git a/core/common/.github/scripts/remove-response-label.cjs b/core/common/.github/scripts/remove-response-label.cjs
@@ -0,0 +1,33 @@
+// 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.
+
+module.exports = async ({ github, context }) => {
+    const commenter = context.actor;
+    const issue = await github.rest.issues.get({
+      owner: context.repo.owner,
+      repo: context.repo.repo,
+      issue_number: context.issue.number,
+    });
+    const author = issue.data.user.login;
+    const labels = issue.data.labels.map((e) => e.name);
+  
+    if (author === commenter && labels.includes('needs more info')) {
+      await github.rest.issues.removeLabel({
+        owner: context.repo.owner,
+        repo: context.repo.repo,
+        issue_number: context.issue.number,
+        name: 'needs more info',
+      });
+    }
+  };
diff --git a/core/common/.jsdoc.js b/core/common/.jsdoc.js
@@ -31,7 +31,7 @@ module.exports = {
   source: {
     excludePattern: '(^|\\/|\\\\)[._]',
     include: [
-      'src',
+      'build/src',
     ],
     includePattern: '\\.js$'
   },
diff --git a/core/common/.repo-metadata.json b/core/common/.repo-metadata.json
@@ -7,5 +7,6 @@
   "distribution_name": "@google-cloud/common",
   "client_documentation": "https://googleapis.dev/nodejs/common/latest",
   "api_shortname": "common",
+  "codeowner_team": "@googleapis/jsteam-handwritten-libraries",
   "library_type": "CORE"
 }
diff --git a/core/common/README.md b/core/common/README.md
@@ -116,4 +116,4 @@ See [LICENSE](https://github.com/googleapis/nodejs-common/blob/main/LICENSE)
 [projects]: https://console.cloud.google.com/project
 [billing]: https://support.google.com/cloud/answer/6293499#enable-billing
 
-[auth]: https://cloud.google.com/docs/authentication/getting-started
+[auth]: https://cloud.google.com/docs/authentication/external/set-up-adc-local
diff --git a/core/common/owlbot.py b/core/common/owlbot.py
@@ -21,5 +21,4 @@
 
 common_templates = gcp.CommonTemplates()
 templates = common_templates.node_library()
-s.copy(templates)
-node.fix()
+s.copy(templates, excludes = [".github/ISSUE_TEMPLATE", ".github/workflows/issues-no-repro.yaml", ".github/scripts/close-invalid-link.cjs"])
diff --git a/core/common/package.json b/core/common/package.json
@@ -15,7 +15,7 @@
     "!build/src/**/*.map"
   ],
   "scripts": {
-    "docs": "compodoc src/",
+    "docs": "jsdoc -c .jsdoc.js",
     "test": "c8 mocha build/test",
     "prepare": "npm run compile",
     "pretest": "npm run compile",
@@ -43,7 +43,6 @@
     "teeny-request": "^9.0.0"
   },
   "devDependencies": {
-    "@compodoc/compodoc": "1.1.19",
     "@types/ent": "^2.2.1",
     "@types/extend": "^3.0.1",
     "@types/mocha": "^9.0.0",
@@ -57,6 +56,9 @@
     "c8": "^8.0.1",
     "codecov": "^3.6.5",
     "gts": "^5.0.0",
+    "jsdoc": "^4.0.0",
+    "jsdoc-fresh": "^3.0.0",
+    "jsdoc-region-tag": "^3.0.0",
     "linkinator": "^3.0.0",
     "mocha": "^9.2.2",
     "mv": "^2.1.1",

-Original file line number
+Diff line change
@@ @@ -0,0 +1,4 @@ @@
 +---
 +name: Process Request
 +about: Submit a process request to the library. Process requests are any requests related to library infrastructure, for example CI/CD, publishing, releasing, broken links.
 +---