Skip to content

Commit

Permalink
chore: update links in github issue templates (#682)
Browse files Browse the repository at this point in the history
* 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

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 <[email protected]>
Co-authored-by: Sofia Leon <[email protected]>
  • Loading branch information
4 people authored Oct 21, 2024
1 parent 85c831d commit 496b45a
Show file tree
Hide file tree
Showing 14 changed files with 49 additions and 253 deletions.
4 changes: 2 additions & 2 deletions .github/.OwlBot.lock.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -13,5 +13,5 @@
# limitations under the License.
docker:
image: gcr.io/cloud-devrel-public-resources/owlbot-nodejs:latest
digest: sha256:a5af6af827a9fffba373151e1453b0498da288024cdd16477900dd42857a42e0
# created: 2024-09-20T20:26:11.126243246Z
digest: sha256:609822e3c09b7a1bd90b99655904609f162cc15acb4704f1edf778284c36f429
# created: 2024-10-01T19:34:30.797530443Z
38 changes: 0 additions & 38 deletions .github/ISSUE_TEMPLATE/bug_report.md

This file was deleted.

31 changes: 4 additions & 27 deletions .github/ISSUE_TEMPLATE/bug_report.yml
Original file line number Diff line number Diff line change
Expand Up @@ -24,12 +24,12 @@ body:
e.js"
required: true
- label: "Check our Troubleshooting guide:
https://googlecloudplatform.github.io/google-cloud-node/#/docs/guid\
es/troubleshooting"
https://github.com/googleapis/google-cloud-node/blob/main/docs/trou\
bleshooting.md"
required: true
- label: "Check our FAQ:
https://googlecloudplatform.github.io/google-cloud-node/#/docs/guid\
es/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\
Expand All @@ -41,34 +41,11 @@ body:
- 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://github.com/googleapis/github-repo-automation/issues
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: >
Expand Down
4 changes: 0 additions & 4 deletions .github/ISSUE_TEMPLATE/config.yml

This file was deleted.

18 changes: 0 additions & 18 deletions .github/ISSUE_TEMPLATE/feature_request.md

This file was deleted.

24 changes: 1 addition & 23 deletions .github/ISSUE_TEMPLATE/feature_request.yml
Original file line number Diff line number Diff line change
Expand Up @@ -11,28 +11,6 @@ body:
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://github.com/googleapis/github-repo-automation/issues))
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: >
Expand All @@ -50,4 +28,4 @@ body:

- type: textarea
attributes:
label: Additional context/notes
label: Additional context/notes
5 changes: 2 additions & 3 deletions .github/ISSUE_TEMPLATE/processs_request.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
---
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.

---
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.
---
12 changes: 0 additions & 12 deletions .github/ISSUE_TEMPLATE/question.md

This file was deleted.

53 changes: 0 additions & 53 deletions .github/scripts/close-invalid-link.cjs

This file was deleted.

18 changes: 0 additions & 18 deletions .github/workflows/issues-no-repro.yaml

This file was deleted.

51 changes: 0 additions & 51 deletions .jsdoc.js

This file was deleted.

34 changes: 34 additions & 0 deletions .jsdoc.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
{
"opts": {
"readme": "./README.md",
"package": "./package.json",
"template": "./node_modules/jsdoc-fresh",
"recurse": true,
"verbose": true,
"destination": "./docs/"
},
"plugins": [
"plugins/markdown",
"jsdoc-region-tag"
],
"source": {
"excludePattern": "(^|\\/|\\\\)[._]",
"include": [
"build/src"
],
"includePattern": "\\.js$"
},
"templates": {
"copyright": "Copyright 2024 Google, LLC.",
"includeDate": "false",
"sourceFiles": false,
"systemName": "@google/repo",
"theme": "lumen",
"default": {
"outputSourceFiles": false
}
},
"markdown": {
"idInHeadings": true
}
}
2 changes: 1 addition & 1 deletion owlbot.py
Original file line number Diff line number Diff line change
Expand Up @@ -14,4 +14,4 @@

import synthtool.languages.node as node

node.owlbot_main(templates_excludes=["README.md", ".prettierrc.js", ".mocharc.js"])
node.owlbot_main(templates_excludes=["README.md", ".prettierrc.js", ".mocharc.js",".github/ISSUE_TEMPLATE", ".github/scripts", ".github/workflows/issues-no-repro.yaml"])
8 changes: 5 additions & 3 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,6 @@
"tweetsodium": "0.0.5"
},
"devDependencies": {
"@compodoc/compodoc": "1.1.19",
"@types/js-yaml": "^4.0.5",
"@types/meow": "6.0.0",
"@types/mocha": "^9.1.1",
Expand All @@ -44,15 +43,18 @@
"c8": "^9.0.0",
"gts": "^5.0.0",
"linkinator": "^3.0.2",
"jsdoc": "^4.0.0",
"jsdoc-fresh": "^3.0.0",
"jsdoc-region-tag": "^3.0.0",
"mocha": "^10.0.0",
"nock": "^13.2.9",
"proxyquire": "^2.1.3",
"sinon": "^15.0.0",
"sinon": "^17.0.0",
"typescript": "5.1.6"
},
"scripts": {
"lint": "gts check",
"docs": "compodoc src/",
"docs": "jsdoc -c .jsdoc.json",
"test": "c8 mocha build/test",
"check": "gts check",
"clean": "gts clean",
Expand Down

0 comments on commit 496b45a

Please sign in to comment.