Skip to content

Commit a65d8a1

Browse files
gcf-owl-bot[bot]d-googsofisl
authored
chore: update links in github issue templates and switch to using compodoc (#1876)
* 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 * Delete .github/ISSUE_TEMPLATE/bug_report.md * Delete .github/ISSUE_TEMPLATE/documentation_request.yml * Delete .github/ISSUE_TEMPLATE/feature_request.md * Delete .github/ISSUE_TEMPLATE/question.md * 🦉 Updates from OwlBot post-processor See https://github.com/googleapis/repo-automation-bots/blob/main/packages/owl-bot/README.md * 🦉 Updates from OwlBot post-processor See https://github.com/googleapis/repo-automation-bots/blob/main/packages/owl-bot/README.md * 🦉 Updates from OwlBot post-processor See https://github.com/googleapis/repo-automation-bots/blob/main/packages/owl-bot/README.md * Update package.json * Update .jsdoc.js * Update owlbot.py --------- Co-authored-by: Owl Bot <gcf-owl-bot[bot]@users.noreply.github.com> Co-authored-by: Daniel Bankhead <[email protected]> Co-authored-by: sofisl <[email protected]>
1 parent 2453a46 commit a65d8a1

10 files changed

+20
-83
lines changed

.github/.OwlBot.lock.yaml

+2-2
Original file line numberDiff line numberDiff line change
@@ -13,5 +13,5 @@
1313
# limitations under the License.
1414
docker:
1515
image: gcr.io/cloud-devrel-public-resources/owlbot-nodejs:latest
16-
digest: sha256:a5af6af827a9fffba373151e1453b0498da288024cdd16477900dd42857a42e0
17-
# created: 2024-09-20T20:26:11.126243246Z
16+
digest: sha256:609822e3c09b7a1bd90b99655904609f162cc15acb4704f1edf778284c36f429
17+
# created: 2024-10-01T19:34:30.797530443Z

.github/ISSUE_TEMPLATE/bug_report.md

-38
This file was deleted.

.github/ISSUE_TEMPLATE/bug_report.yml

+6-6
Original file line numberDiff line numberDiff line change
@@ -24,12 +24,12 @@ body:
2424
e.js"
2525
required: true
2626
- label: "Check our Troubleshooting guide:
27-
https://googlecloudplatform.github.io/google-cloud-node/#/docs/guid\
28-
es/troubleshooting"
27+
https://github.com/googleapis/google-cloud-node/blob/main/docs/trou\
28+
bleshooting.md"
2929
required: true
3030
- label: "Check our FAQ:
31-
https://googlecloudplatform.github.io/google-cloud-node/#/docs/guid\
32-
es/faq"
31+
https://github.com/googleapis/google-cloud-node/blob/main/docs/faq.\
32+
md"
3333
required: true
3434
- label: "Check our libraries HOW-TO:
3535
https://github.com/googleapis/gax-nodejs/blob/main/client-libraries\
@@ -55,9 +55,9 @@ body:
5555
behavior you are experiencing. If the behavior is the same, it means
5656
that you are likely experiencing a bug with the API itself. In that
5757
case, please submit an issue to the API team, either by submitting an
58-
issue in its issue tracker https://cloud.google.com/support/docs/issue-trackers, or by
58+
issue in its issue tracker (https://cloud.google.com/support/docs/issue-trackers), or by
5959
submitting an issue in its linked tracker in the .repo-metadata.json
60-
file
60+
file
6161
validations:
6262
required: true
6363
- type: input

.github/ISSUE_TEMPLATE/feature_request.md

-18
This file was deleted.
+2-3
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,4 @@
11
---
22
name: Process Request
3-
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.
4-
5-
---
3+
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.
4+
---

.github/ISSUE_TEMPLATE/question.md

-12
This file was deleted.

.github/scripts/close-invalid-link.cjs

+4-1
Original file line numberDiff line numberDiff line change
@@ -40,9 +40,12 @@ module.exports = async ({github, context}) => {
4040
const isBugTemplate = issue.data.body.includes('Link to the code that reproduces this issue');
4141

4242
if (isBugTemplate) {
43+
console.log(`Issue ${number} is a bug template`)
4344
try {
44-
const link = issue.data.body.split('\n')[18].match(/(https?:\/\/g?i?s?t?\.?github.com\/.*)/);
45+
const link = issue.data.body.split('\n')[18].match(/(https?:\/\/(gist\.)?github.com\/.*)/)[0];
46+
console.log(`Issue ${number} contains this link: ${link}`)
4547
const isValidLink = (await fetch(link)).ok;
48+
console.log(`Issue ${number} has a ${isValidLink ? 'valid' : 'invalid'} link`)
4649
if (!isValidLink) {
4750
await closeIssue(github, owner, repo, number);
4851
}

.jsdoc.js

+1-1
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ module.exports = {
3131
source: {
3232
excludePattern: '(^|\\/|\\\\)[._]',
3333
include: [
34-
'src',
34+
'build/src',
3535
],
3636
includePattern: '\\.js$'
3737
},

owlbot.py

+1
Original file line numberDiff line numberDiff line change
@@ -22,5 +22,6 @@
2222
node.owlbot_main(
2323
templates_excludes=[
2424
".github/workflows/ci.yaml",
25+
".github/ISSUE_TEMPLATE/bug_report.yml"
2526
],
2627
)

package.json

+4-2
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,6 @@
2525
"jws": "^4.0.0"
2626
},
2727
"devDependencies": {
28-
"@compodoc/compodoc": "1.1.23",
2928
"@types/base64-js": "^1.2.5",
3029
"@types/chai": "^4.1.7",
3130
"@types/jws": "^3.1.0",
@@ -42,6 +41,9 @@
4241
"execa": "^5.0.0",
4342
"gts": "^5.0.0",
4443
"is-docker": "^2.0.0",
44+
"jsdoc": "^4.0.0",
45+
"jsdoc-fresh": "^3.0.0",
46+
"jsdoc-region-tag": "^3.0.0",
4547
"karma": "^6.0.0",
4648
"karma-chrome-launcher": "^3.0.0",
4749
"karma-coverage": "^2.0.0",
@@ -76,7 +78,7 @@
7678
"compile": "tsc -p .",
7779
"fix": "gts fix",
7880
"pretest": "npm run compile -- --sourceMap",
79-
"docs": "compodoc src/",
81+
"docs": "jsdoc -c .jsdoc.json",
8082
"samples-setup": "cd samples/ && npm link ../ && npm run setup && cd ../",
8183
"samples-test": "cd samples/ && npm link ../ && npm test && cd ../",
8284
"system-test": "mocha build/system-test --timeout 60000",

0 commit comments

Comments
 (0)