build: don't run test scripts in verbose mode (#501)

googleapis · May 30, 2019 · 8fb604e · 8fb604e
1 parent 62dca18
commit 8fb604e
Show file tree

Hide file tree

Showing 11 changed files with 70 additions and 19 deletions.
diff --git a/.gitignore b/.gitignore
@@ -5,3 +5,4 @@ out
 node_modules
 package-lock.json
 .coverage
+docs
diff --git a/.jsdoc.js b/.jsdoc.js
@@ -0,0 +1,48 @@
+/*!
+ * Copyright 2018 Google LLC. All Rights Reserved.
+ *
+ * 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.
+ */
+
+'use strict';
+
+module.exports = {
+  opts: {
+    readme: './README.md',
+    package: './package.json',
+    template: './node_modules/jsdoc-baseline',
+    recurse: true,
+    verbose: true,
+    destination: './docs/'
+  },
+  plugins: [
+    'plugins/markdown'
+  ],
+  markdown: {
+    idInHeadings: true
+  },
+  source: {
+    excludePattern: '(^|\\/|\\\\)[._]',
+    include: [
+      'out/src'
+    ],
+    includePattern: '\\.js$'
+  },
+  templates: {
+    copyright: 'Copyright 2018 Google, LLC.',
+    includeDate: false,
+    sourceFiles: false,
+    systemName: '@google-cloud/profiler',
+    theme: 'lumen'
+  }
+};
diff --git a/.kokoro/docs.sh b/.kokoro/docs.sh
@@ -14,7 +14,7 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-set -xeo pipefail
+set -eo pipefail
 
 export NPM_CONFIG_PREFIX=/home/node/.npm-global
 

diff --git a/.kokoro/golint.sh b/.kokoro/golint.sh
@@ -14,7 +14,7 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-set -xeo pipefail
+set -eo pipefail
 
 export NPM_CONFIG_PREFIX=/home/node/.npm-global
 

diff --git a/.kokoro/lint.sh b/.kokoro/lint.sh
@@ -14,7 +14,7 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-set -xeo pipefail
+set -eo pipefail
 
 export NPM_CONFIG_PREFIX=/home/node/.npm-global
 

diff --git a/.kokoro/samples-test.sh b/.kokoro/samples-test.sh
@@ -14,7 +14,7 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-set -xeo pipefail
+set -eo pipefail
 
 export NPM_CONFIG_PREFIX=/home/node/.npm-global
 

diff --git a/.kokoro/system-test.sh b/.kokoro/system-test.sh
@@ -14,7 +14,7 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-set -xeo pipefail
+set -eo pipefail
 
 export NPM_CONFIG_PREFIX=/home/node/.npm-global
 

diff --git a/.kokoro/test.sh b/.kokoro/test.sh
@@ -14,7 +14,7 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-set -xeo pipefail
+set -eo pipefail
 
 export NPM_CONFIG_PREFIX=/home/node/.npm-global
 

diff --git a/.kokoro/trampoline.sh b/.kokoro/trampoline.sh
@@ -13,7 +13,7 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-set -xeo pipefail
+set -eo pipefail
 
 # Always run the cleanup script, regardless of the success of bouncing into
 # the container.

diff --git a/README.md b/README.md
@@ -80,7 +80,7 @@ application default credentials:
 
 ## Configuration
 
-See [the default configuration](ts/src/config.ts) for a list of possible
+See [the default configuration](https://github.com/googleapis/cloud-profiler-nodejs/blob/master/ts/src/config.ts) for a list of possible
 configuration options. These options can be passed to the agent through the
 object argument to the start command shown below:
 
@@ -262,17 +262,17 @@ the service when starting the profiler:
        });
        ```
 [app-default-credentials]: https://developers.google.com/identity/protocols/application-default-credentials
-[circle-image]: https://circleci.com/gh/GoogleCloudPlatform/cloud-profiler-nodejs.svg?style=svg
-[circle-url]: https://circleci.com/gh/GoogleCloudPlatform/cloud-profiler-nodejs
+[circle-image]: https://circleci.com/gh/googleapis/cloud-profiler-nodejs.svg?style=svg
+[circle-url]: https://circleci.com/gh/googleapis/cloud-profiler-nodejs
 [cloud-console]: https://console.cloud.google.com
-[coveralls-image]: https://coveralls.io/repos/GoogleCloudPlatform/cloud-profiler-nodejs/badge.svg?branch=master&service=github
-[david-image]: https://david-dm.org/GoogleCloudPlatform/cloud-profiler-nodejs.svg
-[david-url]: https://david-dm.org/GoogleCloudPlatform/cloud-profiler-nodejs
-[david-dev-image]: https://david-dm.org/GoogleCloudPlatform/cloud-profiler-nodejs/dev-status.svg
-[david-dev-url]: https://david-dm.org/GoogleCloudPlatform/cloud-profiler-nodejs#info=devDependencies
+[coveralls-image]: https://coveralls.io/repos/googleapis/cloud-profiler-nodejs/badge.svg?branch=master&service=github
+[david-image]: https://david-dm.org/googleapis/cloud-profiler-nodejs.svg
+[david-url]: https://david-dm.org/googleapis/cloud-profiler-nodejs
+[david-dev-image]: https://david-dm.org/googleapis/cloud-profiler-nodejs/dev-status.svg
+[david-dev-url]: https://david-dm.org/googleapis/cloud-profiler-nodejs#info=devDependencies
 [gcloud-sdk]: https://cloud.google.com/sdk/gcloud/
 [npm-image]: https://badge.fury.io/js/%40google-cloud%2Fprofiler.svg
 [npm-url]: https://npmjs.org/package/@google-cloud/profiler
 [service-account]: https://console.developers.google.com/apis/credentials/serviceaccountkey
-[snyk-image]: https://snyk.io/test/github/GoogleCloudPlatform/cloud-profiler-nodejs/badge.svg
-[snyk-url]: https://snyk.io/test/github/GoogleCloudPlatform/cloud-profiler-nodejs
+[snyk-image]: https://snyk.io/test/github/googleapis/cloud-profiler-nodejs/badge.svg
+[snyk-url]: https://snyk.io/test/github/googleapis/cloud-profiler-nodejs
diff --git a/package.json b/package.json
@@ -15,14 +15,14 @@
     "compile": "tsc -p .",
     "fix": "gts fix",
     "lint": "gts check",
-    "docs": "echo 'no docs yet'",
+    "docs": "jsdoc -c .jsdoc.js",
     "prepare": "npm run compile",
     "pretest": "npm run compile",
     "posttest": "npm run check && npm run license-check",
     "proto": "npm run proto:profile && npm run proto:profiler",
     "proto:profiler": "mkdir -p proto && pbjs -t static-module -w commonjs -o proto/profiler.js third_party/googleapis/google/devtools/cloudprofiler/v2/profiler.proto && pbts -o proto/profiler.d.ts proto/profiler.js",
     "license-check": "jsgl --local .",
-    "docs-test": "linkinator docs -r --skip www.googleapis.com",
+    "docs-test": "linkinator docs -r --skip 'circleci.com/gh/googleapis/cloud-profiler-nodejs'",
     "predocs-test": "npm run docs"
   },
   "author": {
@@ -57,6 +57,8 @@
     "gts": "^1.0.0",
     "intelli-espower-loader": "^1.0.1",
     "js-green-licenses": "^0.5.0",
+    "jsdoc": "^3.6.2",
+    "jsdoc-baseline": "^0.1.1",
     "linkinator": "^1.1.2",
     "mocha": "^6.1.4",
     "nock": "^10.0.0",