From 47923bc0049a8a28915bb5849931d3376e097d95 Mon Sep 17 00:00:00 2001 From: Dave Gramlich Date: Wed, 10 Aug 2016 21:49:54 -0400 Subject: [PATCH 01/10] docs: refactoring doc scripts for modularization --- docs/home.html | 2 +- .../bigquery => bigquery/master}/.gitkeep | 0 .../bigtable => bigtable/master}/.gitkeep | 0 .../compute => compute/master}/.gitkeep | 0 .../datastore => datastore/master}/.gitkeep | 0 docs/json/{master/dns => dns/master}/.gitkeep | 0 .../language => google-cloud/master}/.gitkeep | 0 .../logging => language/master}/.gitkeep | 0 .../prediction => logging/master}/.gitkeep | 0 .../pubsub => prediction/master}/.gitkeep | 0 .../resource => pubsub/master}/.gitkeep | 0 .../storage => resource/master}/.gitkeep | 0 .../translate => storage/master}/.gitkeep | 0 .../vision => translate/master}/.gitkeep | 0 docs/json/vision/master/.gitkeep | 0 docs/manifest.json | 162 +++++++++---- package.json | 5 +- scripts/build.sh | 5 +- scripts/docs/base-toc.json | 32 +++ scripts/docs/bundle.js | 220 ++++++++++++++++++ scripts/docs/config.js | 79 +++++++ scripts/docs/overview.template.html | 42 ++++ scripts/docs/packages.js | 126 ++++++++++ scripts/{docs.js => docs/parser.js} | 123 ++++++---- scripts/release.sh | 12 +- 25 files changed, 706 insertions(+), 102 deletions(-) rename docs/json/{master/bigquery => bigquery/master}/.gitkeep (100%) rename docs/json/{master/bigtable => bigtable/master}/.gitkeep (100%) rename docs/json/{master/compute => compute/master}/.gitkeep (100%) rename docs/json/{master/datastore => datastore/master}/.gitkeep (100%) rename docs/json/{master/dns => dns/master}/.gitkeep (100%) rename docs/json/{master/language => google-cloud/master}/.gitkeep (100%) rename docs/json/{master/logging => language/master}/.gitkeep (100%) rename docs/json/{master/prediction => logging/master}/.gitkeep (100%) rename docs/json/{master/pubsub => prediction/master}/.gitkeep (100%) rename docs/json/{master/resource => pubsub/master}/.gitkeep (100%) rename docs/json/{master/storage => resource/master}/.gitkeep (100%) rename docs/json/{master/translate => storage/master}/.gitkeep (100%) rename docs/json/{master/vision => translate/master}/.gitkeep (100%) create mode 100644 docs/json/vision/master/.gitkeep create mode 100644 scripts/docs/base-toc.json create mode 100644 scripts/docs/bundle.js create mode 100644 scripts/docs/config.js create mode 100644 scripts/docs/overview.template.html create mode 100644 scripts/docs/packages.js rename scripts/{docs.js => docs/parser.js} (76%) diff --git a/docs/home.html b/docs/home.html index b7e26499341..5bdb9f855c2 100644 --- a/docs/home.html +++ b/docs/home.html @@ -22,7 +22,7 @@

  • - + Node.js icon Read the Docs diff --git a/docs/json/master/bigquery/.gitkeep b/docs/json/bigquery/master/.gitkeep similarity index 100% rename from docs/json/master/bigquery/.gitkeep rename to docs/json/bigquery/master/.gitkeep diff --git a/docs/json/master/bigtable/.gitkeep b/docs/json/bigtable/master/.gitkeep similarity index 100% rename from docs/json/master/bigtable/.gitkeep rename to docs/json/bigtable/master/.gitkeep diff --git a/docs/json/master/compute/.gitkeep b/docs/json/compute/master/.gitkeep similarity index 100% rename from docs/json/master/compute/.gitkeep rename to docs/json/compute/master/.gitkeep diff --git a/docs/json/master/datastore/.gitkeep b/docs/json/datastore/master/.gitkeep similarity index 100% rename from docs/json/master/datastore/.gitkeep rename to docs/json/datastore/master/.gitkeep diff --git a/docs/json/master/dns/.gitkeep b/docs/json/dns/master/.gitkeep similarity index 100% rename from docs/json/master/dns/.gitkeep rename to docs/json/dns/master/.gitkeep diff --git a/docs/json/master/language/.gitkeep b/docs/json/google-cloud/master/.gitkeep similarity index 100% rename from docs/json/master/language/.gitkeep rename to docs/json/google-cloud/master/.gitkeep diff --git a/docs/json/master/logging/.gitkeep b/docs/json/language/master/.gitkeep similarity index 100% rename from docs/json/master/logging/.gitkeep rename to docs/json/language/master/.gitkeep diff --git a/docs/json/master/prediction/.gitkeep b/docs/json/logging/master/.gitkeep similarity index 100% rename from docs/json/master/prediction/.gitkeep rename to docs/json/logging/master/.gitkeep diff --git a/docs/json/master/pubsub/.gitkeep b/docs/json/prediction/master/.gitkeep similarity index 100% rename from docs/json/master/pubsub/.gitkeep rename to docs/json/prediction/master/.gitkeep diff --git a/docs/json/master/resource/.gitkeep b/docs/json/pubsub/master/.gitkeep similarity index 100% rename from docs/json/master/resource/.gitkeep rename to docs/json/pubsub/master/.gitkeep diff --git a/docs/json/master/storage/.gitkeep b/docs/json/resource/master/.gitkeep similarity index 100% rename from docs/json/master/storage/.gitkeep rename to docs/json/resource/master/.gitkeep diff --git a/docs/json/master/translate/.gitkeep b/docs/json/storage/master/.gitkeep similarity index 100% rename from docs/json/master/translate/.gitkeep rename to docs/json/storage/master/.gitkeep diff --git a/docs/json/master/vision/.gitkeep b/docs/json/translate/master/.gitkeep similarity index 100% rename from docs/json/master/vision/.gitkeep rename to docs/json/translate/master/.gitkeep diff --git a/docs/json/vision/master/.gitkeep b/docs/json/vision/master/.gitkeep new file mode 100644 index 00000000000..e69de29bb2d diff --git a/docs/manifest.json b/docs/manifest.json index 35d37b7c397..10e9eaad568 100644 --- a/docs/manifest.json +++ b/docs/manifest.json @@ -2,53 +2,125 @@ "lang": "node", "friendlyLang": "Node.js", "markdown": "javascript", - "versions": [ - "v0.37.0", - "v0.36.0", - "v0.35.0", - "v0.34.0", - "v0.33.0", - "v0.32.0", - "v0.31.0", - "v0.30.3", - "v0.30.2", - "v0.30.1", - "v0.30.0", - "v0.29.0", - "v0.28.0", - "v0.27.0", - "v0.26.0", - "v0.25.1", - "v0.25.0", - "v0.24.1", - "v0.24.0", - "v0.23.0", - "v0.22.0", - "v0.21.0", - "v0.20.0", - "v0.19.1", - "v0.19.0", - "v0.18.0", - "v0.17.0", - "v0.16.0", - "v0.15.0", - "v0.14.0", - "v0.13.2", - "v0.13.1", - "v0.12.0", - "v0.11.0", - "v0.10.0", - "v0.9.0", - "v0.8.1", - "v0.8.0", - "v0.7.1", - "v0.7.0", - "v0.6.0", - "v0.5.0", - "master" - ], "content": "json", "home": "home.html", + "titleDelimiter": " » ", + "defaultModule": "google-cloud", + "modules": [ + { + "id": "google-cloud", + "name": "google-cloud", + "defaultService": "google-cloud", + "versions": [ + "master" + ] + }, + { + "id": "bigquery", + "name": "@google-cloud/bigquery", + "defaultService": "bigquery", + "versions": [ + "master" + ] + }, + { + "id": "bigtable", + "name": "@google-cloud/bigtable", + "defaultService": "bigtable", + "versions": [ + "v0.1.0", + "master" + ] + }, + { + "id": "compute", + "name": "@google-cloud/compute", + "defaultService": "compute", + "versions": [ + "master" + ] + }, + { + "id": "datastore", + "name": "@google-cloud/datastore", + "defaultService": "datastore", + "versions": [ + "master" + ] + }, + { + "id": "dns", + "name": "@google-cloud/dns", + "defaultService": "dns", + "versions": [ + "master" + ] + }, + { + "id": "language", + "name": "@google-cloud/language", + "defaultService": "language", + "versions": [ + "master" + ] + }, + { + "id": "logging", + "name": "@google-cloud/logging", + "defaultService": "logging", + "versions": [ + "master" + ] + }, + { + "id": "prediction", + "name": "@google-cloud/prediction", + "defaultService": "prediction", + "versions": [ + "master" + ] + }, + { + "id": "pubsub", + "name": "@google-cloud/pubsub", + "defaultService": "pubsub", + "versions": [ + "master" + ] + }, + { + "id": "resource", + "name": "@google-cloud/resource", + "defaultService": "resource", + "versions": [ + "master" + ] + }, + { + "id": "storage", + "name": "@google-cloud/storage", + "defaultService": "storage", + "versions": [ + "master" + ] + }, + { + "id": "translate", + "name": "@google-cloud/translate", + "defaultService": "translate", + "versions": [ + "master" + ] + }, + { + "id": "vision", + "name": "@google-cloud/vision", + "defaultService": "vision", + "versions": [ + "master" + ] + } + ], "package": { "title": "npm", "href": "https://www.npmjs.com/package/gcloud" diff --git a/package.json b/package.json index 79b0e2fa44b..0f9a7b78b01 100644 --- a/package.json +++ b/package.json @@ -10,11 +10,13 @@ "istanbul": "^0.3.5", "jscs": "^2.1.1", "jshint": "^2.9.1", + "lodash.template": "^4.3.0", "mitm": "^1.1.0", "mocha": "^3.0.1", "propprop": "^0.3.0", "proxyquire": "^1.7.10", "request": "^2.70.0", + "semver": "^5.3.0", "shelljs": "^0.7.3", "string-format-obj": "^1.0.0", "through2": "^2.0.0" @@ -23,7 +25,8 @@ "link-modules": "node ./scripts/link.js", "install-module-dependencies": "node ./scripts/install.js", "postinstall": "npm run link-modules && npm run install-module-dependencies", - "docs": "node ./scripts/docs.js", + "docs": "node ./scripts/docs/packages.js", + "bundle": "node ./scripts/docs/bundle.js", "lint": "jshint scripts/ packages/ system-test/ test/ && jscs packages/ system-test/ test/", "test": "npm run docs && mocha test/docs.js packages/*/test/*.js", "system-test": "mocha packages/*/system-test/*.js --no-timeouts --bail", diff --git a/scripts/build.sh b/scripts/build.sh index d9bde937207..b0f3f2b7015 100755 --- a/scripts/build.sh +++ b/scripts/build.sh @@ -28,9 +28,8 @@ if [ "${TRAVIS_BRANCH}" == "master" ] && [ "${TRAVIS_PULL_REQUEST}" == "false" ] # add new docs to the gh-pages branch git submodule add -b gh-pages https://${GH_OAUTH_TOKEN}@github.com/${GH_OWNER}/${GH_PROJECT_NAME} ghpages # copy all the docs file that might have changed, excluding versions.txt (to avoid overriding it) - cp -R docs/json/master/* ghpages/json/master - cp docs/*{.md,.html} ghpages/json/master - cp docs/toc.json ghpages/json/master + cp -R docs/json/* ghpages/json + npm run bundle cp docs/home.html ghpages/json cp docs/manifest.json ghpages cd ghpages diff --git a/scripts/docs/base-toc.json b/scripts/docs/base-toc.json new file mode 100644 index 00000000000..17f3e80a931 --- /dev/null +++ b/scripts/docs/base-toc.json @@ -0,0 +1,32 @@ +{ + "guides": [{ + "title": "Authentication", + "id": "authentication", + "edit": "https://github.com/GoogleCloudPlatform/gcloud-common/edit/master/authentication/readme.md", + "contents": [ + "https://raw.githubusercontent.com/GoogleCloudPlatform/gcloud-common/master/authentication/readme.md", + "authentication.md" + ] + }, { + "title": "FAQ", + "id": "faq", + "edit": "https://github.com/GoogleCloudPlatform/gcloud-common/edit/master/faq/readme.md", + "contents": [ + "https://raw.githubusercontent.com/GoogleCloudPlatform/gcloud-common/master/faq/readme.md", + "faq.md" + ] + }, { + "title": "Troubleshooting", + "id": "troubleshooting", + "edit": "https://github.com/GoogleCloudPlatform/gcloud-common/edit/master/troubleshooting/readme.md", + "contents": [ + "https://raw.githubusercontent.com/GoogleCloudPlatform/gcloud-common/master/troubleshooting/readme.md", + "troubleshooting.md" + ] + }, { + "title": "Contributing", + "id": "contributing", + "edit": "https://github.com/GoogleCloudPlatform/gcloud-common/edit/master/contributing/readme.md", + "contents": "https://raw.githubusercontent.com/GoogleCloudPlatform/gcloud-common/master/contributing/readme.md" + }] +} diff --git a/scripts/docs/bundle.js b/scripts/docs/bundle.js new file mode 100644 index 00000000000..df543f3773a --- /dev/null +++ b/scripts/docs/bundle.js @@ -0,0 +1,220 @@ +/** + * Copyright 2014 Google Inc. 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'; + +var path = require('path'); +var globby = require('globby'); +var semver = require('semver'); +var mkdirp = require('mkdirp'); +var fs = require('fs'); +var async = require('async'); +var flatten = require('lodash.flatten'); +var parser = require('./parser'); +var config = require('./config'); + +var JSON_DIR = './ghpages/json'; + +var pkgJson = require('../../packages/google-cloud/package.json'); +var dependencies = pkgJson.dependencies; + +var deps = Object.keys(dependencies).reduce(function(deps, dep) { + if (/^\@google\-cloud/.test(dep)) { + deps.push({ + packageName: dep.replace('@google-cloud/', ''), + semver: dependencies[dep] + }); + } + + return deps; +}, []); + +function getPackageVersion(dep, callback) { + var globOptions = { + cwd: path.join(JSON_DIR, dep.packageName) + }; + + globby('*', globOptions) + .then(function(versions) { + var validVersions = versions.filter(function(version) { + return semver.valid(version); + }); + + var version = semver.maxSatisfying(validVersions, dep.semver); + + if (!version) { + throw new Error( + 'Unable to find suitable version for package: ' + dep.packageName); + } + + callback(null, version); + }) + .then(null, callback); +} + +function getDocsFiles(packageName, version, callback) { + var globOptions = { + cwd: path.join(JSON_DIR, packageName), + ignore: [ + path.join(version, config.TYPES_DICT), + path.join(version, config.TOC) + ] + }; + + globby(path.join(version, '*.json'), globOptions) + .then(callback.bind(null, null), callback); +} + +function copyFile(dep, file, callback) { + var outputDir = path.join( + JSON_DIR, + config.UMBRELLA_PACKAGE, + config.DEFAULT_VERSION, + dep.packageName + ); + + mkdirp(outputDir, function(err) { + if (err) { + callback(err); + return; + } + + var inputFile = path.join( + JSON_DIR, + dep.packageName, + file + ); + + var outputFile = path.join( + outputDir, + path.basename(file) + ); + + fs.readFile(inputFile, 'utf8', function(err, contents) { + if (err) { + callback(err); + return; + } + + var fileJson = JSON.parse(contents); + var service = fileJson.parent || fileJson.id; + + fileJson.overview = parser.createOverview(service, true); + fs.writeFile(outputFile, JSON.stringify(fileJson), callback); + }); + }); +} + +function getTypes(dep, callback) { + var inputFile = path.join( + JSON_DIR, + dep.packageName, + dep.version, + config.TYPES_DICT + ); + + fs.readFile(inputFile, 'utf8', function(err, contents) { + var types = JSON.parse(contents); + + types.forEach(function(type) { + type.contents = path.join(dep.packageName, type.contents); + }); + + callback(null, types); + }); +} + +function createUmbrellaTypes(types, callback) { + var inputFile = path.join( + './docs/json', + config.UMBRELLA_PACKAGE, + config.DEFAULT_VERSION, + config.TYPES_DICT + ); + + fs.readFile(inputFile, 'utf8', function(err, contents) { + if (err) { + callback(err); + return; + } + + var umbrellaTypes = JSON.parse(contents); + var allTypes = umbrellaTypes.concat(types); + + var outputFile = path.join( + JSON_DIR, + config.UMBRELLA_PACKAGE, + config.DEFAULT_VERSION, + config.TYPES_DICT + ); + + fs.writeFile(outputFile, JSON.stringify(allTypes), function(err) { + callback(err, allTypes); + }); + }); +} + +function createUmbrellaToc(types, callback) { + var outputFile = path.join( + JSON_DIR, + config.UMBRELLA_PACKAGE, + config.DEFAULT_VERSION, + config.TOC + ); + + var toc = parser.createToc(types, true); + + fs.writeFile(outputFile, JSON.stringify(toc), callback); +} + +async.map(deps, function(dep, callback) { + async.waterfall([ + function(callback) { + getPackageVersion(dep, callback); + }, + function(version, callback) { + dep.version = version; + getDocsFiles(dep.packageName, version, callback); + }, + function(files, callback) { + async.each(files, copyFile.bind(null, dep), callback); + } + ], function(err) { + if (err) { + callback(err); + return; + } + + getTypes(dep, callback); + }); +}, function(err, types) { + if (err) { + throw err; + } + + async.waterfall([ + function(callback) { + createUmbrellaTypes(flatten(types), callback); + }, + function(types, callback) { + createUmbrellaToc(types, callback); + } + ], function(err) { + if (err) { + throw err; + } + }); +}); diff --git a/scripts/docs/config.js b/scripts/docs/config.js new file mode 100644 index 00000000000..f8d6f42844c --- /dev/null +++ b/scripts/docs/config.js @@ -0,0 +1,79 @@ +/** + * Copyright 2014 Google Inc. 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 = { + UMBRELLA_PACKAGE: 'google-cloud', + DEFAULT_VERSION: 'master', + TYPES_DICT: 'types.json', + TOC: 'toc.json', + IGNORE: [ + 'common', + 'datastore/src/entity.js', + 'datastore/src/request.js', + 'pubsub/src/iam.js', + 'storage/src/acl.js', + 'bigtable/src/mutation.js' + ], + OVERVIEW_TEMPLATE: 'overview.template.html', + OVERVIEW: { + 'google-cloud': { + title: 'Google Cloud', + instanceName: 'gcloud' + }, + bigquery: { + title: 'Google BigQuery' + }, + bigtable: { + title: 'Google Cloud Bigtable' + }, + compute: { + title: 'Google Compute Engine' + }, + datastore: { + title: 'Google Cloud Datastore' + }, + dns: { + title: 'Google Cloud DNS' + }, + language: { + title: 'Google Cloud Natural Language' + }, + logging: { + title: 'Google Cloud Logging' + }, + prediction: { + title: 'Google Prediction API' + }, + pubsub: { + title: 'Google Cloud Pub/Sub' + }, + resource: { + title: 'Google Cloud Resource Manager' + }, + storage: { + title: 'Google Cloud Storage', + instanceName: 'gcs' + }, + translate: { + title: 'Google Translate API' + }, + vision: { + title: 'Google Cloud Vision' + } + } +}; diff --git a/scripts/docs/overview.template.html b/scripts/docs/overview.template.html new file mode 100644 index 00000000000..96ef91725a4 --- /dev/null +++ b/scripts/docs/overview.template.html @@ -0,0 +1,42 @@ +

    + This class allows you interact with <%= title %>. +

    + +

    + First, install <%= pkgJson.name %> with npm: +

    + +
    $ npm install --save <%= pkgJson.name %>
    + +

    + If you are running your app on Google Compute Engine, you won't need to worry about supplying connection configuration options to <%= pkgJson.name %>— we figure that out for you. +

    + +

    + However, if you're running your app elsewhere, you will need to provide project details to authenticate API requests. +

    + +

    Compute Engine

    +
    <% if (!umbrellaView) { %> +var <%= instanceName || className %> = require('<%= pkgJson.name %>')();<% } else { %> +var gcloud = require('google-cloud'); +var <%= instanceName || className %> = gcloud.<%= className %>();<% } %> +
    + +

    Elsewhere

    +
    <% if (!umbrellaView) { %> +var <%= instanceName || className %> = require('<%= pkgJson.name %>')({ + projectId: 'grape-spaceship-123', + keyFilename: '/path/to/keyfile.json' +});<% } else { %> +var gcloud = require('google-cloud'); +var <%= instanceName || className %> = gcloud.<%= className %>({ + projectId: 'grape-spaceship-123', + keyFilename: '/path/to/keyfile.json' +});<% } %> +
    + +

    + The full set of options which can be passed to <%= pkgJson.name %> are outlined in our Authentication guide. +

    + diff --git a/scripts/docs/packages.js b/scripts/docs/packages.js new file mode 100644 index 00000000000..939766078f9 --- /dev/null +++ b/scripts/docs/packages.js @@ -0,0 +1,126 @@ +/** + * Copyright 2014 Google Inc. 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'; + +var async = require('async'); +var globby = require('globby'); +var path = require('path'); +var fs = require('fs'); + +var parser = require('./parser'); +var config = require('./config'); + + +var JSON_FOLDER = './docs/json'; + +var globOptions = { + cwd: './packages', + ignore: config.IGNORE +}; + +function getPackages(callback) { + globby('*', globOptions) + .then(callback.bind(null, null), callback); +} + +function getPackageFiles(packageName, callback) { + globby(path.join(packageName, 'src/*.js'), globOptions) + .then(callback.bind(null, null), callback); +} + +function createJSON(packageName, file, callback) { + var inputFile = path.join(globOptions.cwd, file); + var outputFile = path.join( + JSON_FOLDER, + packageName, + config.DEFAULT_VERSION, + file.replace(/^.+src\//, '') + 'on' + ); + + fs.readFile(inputFile, 'utf8', function(err, contents) { + if (err) { + callback(err); + return; + } + + var json = parser.parseFile(inputFile, contents); + + fs.writeFile(outputFile, JSON.stringify(json), function(err) { + json.path = path.basename(outputFile); + callback(err, json); + }); + }); +} + +function createTypesDictionary(packageName, json, callback) { + var outputFile = path.join( + JSON_FOLDER, + packageName, + config.DEFAULT_VERSION, + config.TYPES_DICT + ); + + var types = parser.createTypesDictionary(json); + + fs.writeFile(outputFile, JSON.stringify(types), function(err) { + callback(err, types); + }); +} + +function createTableOfContents(packageName, types, callback) { + var outputFile = path.join( + JSON_FOLDER, + packageName, + config.DEFAULT_VERSION, + config.TOC + ); + + var toc = parser.createToc(types); + + fs.writeFile(outputFile, JSON.stringify(toc), callback); +} + +getPackages(function(err, packages) { + if (err) { + throw err; + } + + async.each(packages, function(packageName, pcallback) { + getPackageFiles(packageName, function(err, files) { + if (err) { + throw err; + } + + async.map(files, function(file, fcallback) { + createJSON(packageName, file, fcallback); + }, function(err, json) { + if (err) { + throw err; + } + + async.waterfall([ + function(callback) { + createTypesDictionary(packageName, json, callback); + }, + function(types, callback) { + createTableOfContents(packageName, types, callback); + } + ], pcallback); + }); + }); + }); +}); diff --git a/scripts/docs.js b/scripts/docs/parser.js similarity index 76% rename from scripts/docs.js rename to scripts/docs/parser.js index cf256c3fa17..4f88cd73fb7 100644 --- a/scripts/docs.js +++ b/scripts/docs/parser.js @@ -16,23 +16,21 @@ 'use strict'; -var async = require('async'); var dox = require('dox'); -var format = require('string-format-obj'); -var fs = require('fs'); var globby = require('globby'); +var fs = require('fs'); var path = require('path'); +var format = require('string-format-obj'); var prop = require('propprop'); +var extend = require('extend'); +var template = require('lodash.template'); +var config = require('./config'); +var baseToc = require('./base-toc.json'); + +var templateFile = fs.readFileSync( + path.join(__dirname, config.OVERVIEW_TEMPLATE)); -var OUTPUT_FOLDER = './docs/json/master'; -var IGNORE = [ - './packages/common/src/*', - './packages/datastore/src/entity.js', - './packages/datastore/src/request.js', - './packages/pubsub/src/iam.js', - './packages/storage/src/acl.js', - './packages/bigtable/src/mutation.js' -]; +var parser = module.exports = {}; function isPublic(block) { return !block.isPrivate && !block.ignore; @@ -101,6 +99,7 @@ function getId(fileName) { var id = fileName .replace(/^(\.\/)?packages\//, '') + .replace('src/', '') .replace('/index.js', '') .replace('.js', ''); @@ -141,7 +140,7 @@ function getChildren(id) { var childrenGlob = './packages/' + id + '/*'; return globby - .sync(childrenGlob, { ignore: IGNORE }) + .sync(childrenGlob, { ignore: config.IGNORE }) .map(getId) .filter(function(child) { return child !== id; @@ -286,18 +285,20 @@ function getMixinMethods(comments) { }, []); } -function parseFile(fileName, contents) { +function parseFile(fileName, contents, umbrellaMode) { var comments = dox.parseComments(contents).filter(isPublic); var constructor = comments.filter(prop('isConstructor'))[0]; var id = getId(fileName); + var parent = getParent(id); return { id: id, type: 'class', name: getName(constructor), + overview: createOverview(parent || id, umbrellaMode), description: getClassDesc(constructor), source: path.normalize(fileName), - parent: getParent(id), + parent: parent, children: getChildren(id), methods: comments .map(createMethod.bind(null, fileName, id)) @@ -309,8 +310,8 @@ function parseFile(fileName, contents) { function createTypesDictionary(docs) { return docs.map(function(service) { var id = service.id; - var title = [id === 'google-cloud' ? 'Node.js' : service.name]; - var contents = service.path.replace('docs/json/master/', ''); + var title = [id === config.UMBRELLA_PACKAGE ? 'Google Cloud' : service.name]; + var contents = service.path; if (service.parent) { for (var i = 0, l = docs.length; i < l; i++) { @@ -322,46 +323,76 @@ function createTypesDictionary(docs) { return { id: id, - title: title.join(' » '), + title: title, contents: contents }; }); } -globby('./packages/*/src/*.js', { ignore: IGNORE }).then(function(files) { - async.map(files, function(file, callback) { - fs.readFile(file, 'utf8', function(err, contents) { - if (err) { - callback(err); - return; +function createToc(types, collapse) { + var toc = extend(true, {}, baseToc); + var services = types + .map(function(type) { + return { + type: type.id, + title: type.title[type.title.length > 1 ? 1 : 0] + }; + }) + .sort(function(a, b) { + if (a.type === config.UMBRELLA_PACKAGE) { + return -1; } - var docs = parseFile(file, contents); - var outputFile = path.join( - OUTPUT_FOLDER, - file.replace('/packages', '').replace('/src/', '/').replace('.js', '.json') - ); - if (outputFile.indexOf('google-cloud') !== -1) { - outputFile = outputFile.replace('/google-cloud/', '/'); + if (b.type === config.UMBRELLA_PACKAGE) { + return 1; } - fs.writeFile(outputFile, JSON.stringify(docs), function(err) { - docs.path = outputFile; - callback(err, docs); - }); + return a.type < b.type ? -1 : a.type > b.type ? 1 : 0; }); - }, function(err, docs) { - if (err) { - throw err; + + if (!collapse) { + toc.services = services; + return toc; + } + + var collapsed = services.reduce(function(collapsed, service) { + var last = collapsed[collapsed.length - 1]; + var parent = service.type.split('/')[0]; + + if (last && last.type === parent) { + last.nav = last.nav || []; + last.nav.push(service); + } else { + collapsed.push(service); } - var types = createTypesDictionary(docs); - var outputFile = path.join(OUTPUT_FOLDER, 'types.json'); + return collapsed; + }, []); - fs.writeFile(outputFile, JSON.stringify(types), function(err) { - if (err) { - throw err; - } - }); + toc.services = collapsed; + return toc; +} + +function createOverview(moduleName, umbrellaMode) { + var modConfig = config.OVERVIEW[moduleName]; + var pkgJson = path.join( + __dirname, + '../../packages', + umbrellaMode ? 'google-cloud' : moduleName, + 'package.json' + ); + + return template(templateFile)({ + pkgJson: require(pkgJson), + title: modConfig.title, + instanceName: modConfig.instanceName, + className: moduleName, + umbrellaView: umbrellaMode && moduleName !== config.UMBRELLA_PACKAGE, + umbrellaPkg: config.UMBRELLA_PACKAGE }); -}); +} + +parser.parseFile = parseFile; +parser.createTypesDictionary = createTypesDictionary; +parser.createToc = createToc; +parser.createOverview = createOverview; diff --git a/scripts/release.sh b/scripts/release.sh index c7898d06f34..6b10e3feffd 100755 --- a/scripts/release.sh +++ b/scripts/release.sh @@ -28,8 +28,8 @@ git config --global user.email "travis@travis-ci.org" git submodule add -f -b master https://${GH_OAUTH_TOKEN}@github.com/${GH_OWNER}/${GH_PROJECT_NAME} master cd master node -e " -file = require('./docs/manifest.json') -if (file.versions.indexOf('${TRAVIS_TAG}') === -1) file.versions.unshift('${TRAVIS_TAG}') +module = require('./docs/manifest.json').modules[0] +if (module.versions.indexOf('${TRAVIS_TAG}') === -1) module.versions.unshift('${TRAVIS_TAG}') require('fs').writeFileSync('docs/manifest.json', JSON.stringify(file, null, 2) + '\n') " # allow "git add" to fail if there aren't new files. @@ -47,10 +47,10 @@ cd ../ ## Upload the docs to gh-pages. git submodule add -f -b gh-pages https://${GH_OAUTH_TOKEN}@github.com/${GH_OWNER}/${GH_PROJECT_NAME} ghpages -test -d "ghpages/json/${TRAVIS_TAG}" && exit 0 || mkdir ghpages/json/${TRAVIS_TAG} -cp -R docs/json/master/* ghpages/json/${TRAVIS_TAG} -cp docs/*{.md,.html} ghpages/json/${TRAVIS_TAG} -cp docs/toc.json ghpages/json/${TRAVIS_TAG} +test -d "ghpages/json/google-cloud/${TRAVIS_TAG}" && exit 0 || mkdir ghpages/json/google-cloud/${TRAVIS_TAG} +npm run bundle +# figure out how to version this stuff.. +# cp docs/*{.md,.html} ghpages/json/${TRAVIS_TAG} cp docs/home.html ghpages/json cp docs/manifest.json ghpages cd ghpages From abe13183b8874c8fae7e33f154c44cb2ad200736 Mon Sep 17 00:00:00 2001 From: Dave Gramlich Date: Thu, 11 Aug 2016 13:27:15 -0400 Subject: [PATCH 02/10] updated doc testing paths --- test/docs.js | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/test/docs.js b/test/docs.js index cc17453bd9f..c79afb02e4f 100644 --- a/test/docs.js +++ b/test/docs.js @@ -70,9 +70,10 @@ describe('documentation', function() { MITM.disable(); }); - var jsonGlob = 'docs/json/master/**/*.json'; + var jsonGlob = 'docs/json/*/master/*.json'; var ignore = [ - 'docs/json/master/types.json' + 'docs/json/*/master/types.json', + 'docs/json/*/master/toc.json' ]; var FILES = glob.sync(jsonGlob, { ignore: ignore }); From 69d84cd37d7469f76f8f650d3deaae84995c2216 Mon Sep 17 00:00:00 2001 From: Dave Gramlich Date: Thu, 11 Aug 2016 13:28:00 -0400 Subject: [PATCH 03/10] refactored json docs steps for umbrella version releases --- scripts/release.sh | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/scripts/release.sh b/scripts/release.sh index 6b10e3feffd..1bbf1e378b9 100755 --- a/scripts/release.sh +++ b/scripts/release.sh @@ -48,9 +48,9 @@ cd ../ ## Upload the docs to gh-pages. git submodule add -f -b gh-pages https://${GH_OAUTH_TOKEN}@github.com/${GH_OWNER}/${GH_PROJECT_NAME} ghpages test -d "ghpages/json/google-cloud/${TRAVIS_TAG}" && exit 0 || mkdir ghpages/json/google-cloud/${TRAVIS_TAG} +cp docs/*.md ghpages/json/google-cloud/${TRAVIS_TAG} npm run bundle -# figure out how to version this stuff.. -# cp docs/*{.md,.html} ghpages/json/${TRAVIS_TAG} +cp -R ghpages/json/google-cloud/master ghpages/json/google-cloud/${TRAVIS_TAG} cp docs/home.html ghpages/json cp docs/manifest.json ghpages cd ghpages From d2687d65a73a763f620866d959fecb4ab16e3f37 Mon Sep 17 00:00:00 2001 From: Dave Gramlich Date: Thu, 11 Aug 2016 13:28:39 -0400 Subject: [PATCH 04/10] updated/removed misc. content files for docs --- docs/authentication.md | 4 +- docs/faq.md | 6 +- docs/overview.html | 23 ----- docs/toc.json | 205 ----------------------------------------- 4 files changed, 5 insertions(+), 233 deletions(-) delete mode 100644 docs/overview.html delete mode 100644 docs/toc.json diff --git a/docs/authentication.md b/docs/authentication.md index 7c26d1481ec..e48be4299ff 100644 --- a/docs/authentication.md +++ b/docs/authentication.md @@ -1,6 +1,6 @@ -## With `google-cloud` +## Authenticating with this module -With `google-cloud` it's incredibly easy to get authenticated and start using Google's APIs. You can set your credentials on a global basis as well as on a per-API basis. See each individual API section below to see how you can auth on a per-API-basis. This is useful if you want to use different accounts for different Google Cloud services. +It's incredibly easy to get authenticated and start using Google's APIs. You can set your credentials on a global basis as well as on a per-API basis. See each individual API section below to see how you can auth on a per-API-basis. This is useful if you want to use different accounts for different Google Cloud services. ```js var config = { diff --git a/docs/faq.md b/docs/faq.md index 64c2e28d46e..19c7540ba47 100644 --- a/docs/faq.md +++ b/docs/faq.md @@ -1,4 +1,4 @@ -## How do I use `gcloud-node` with Google Compute Engine? +## How do I use this module with Google Compute Engine? If you are running this client on Google Compute Engine, we handle authentication for you with no configuration. You just need to make sure that when you [set up the GCE instance][gce-how-to], you add the correct scopes for the APIs you want to access. @@ -8,7 +8,7 @@ If you are running this client on Google Compute Engine, we handle authenticatio If you are not running this client on Google Compute Engine, you need a Google Developers service account. To create a service account, please see our [Authentication][auth-guide] guide. -## How do I use `gcloud-node` with AWS Lambda? +## How do I use this module with AWS Lambda? Our library uses some native libraries, which must be recompiled against the platform running your application. For AWS Lambda, we recommend using [lambda-packager](https://github.com/tomdale/lambda-packager) prior to deploying your code. @@ -17,7 +17,7 @@ Reference Issues: [#1287](https://github.com/GoogleCloudPlatform/gcloud-node/iss ## Does this replace [Google Cloud Node.js Client][googleapis]? -Google Cloud Node.js Client is a client library for using the broad set of Google APIs. `gcloud-node` is built specifically for the Google Cloud Platform and is the recommended way to integrate Google Cloud APIs into your Node.js applications. If your application requires both Google Cloud Platform and other Google APIs, the 2 libraries may be used together. +Google Cloud Node.js Client is a client library for using the broad set of Google APIs. This module is built specifically for the Google Cloud Platform and is the recommended way to integrate Google Cloud APIs into your Node.js applications. If your application requires both Google Cloud Platform and other Google APIs, the 2 libraries may be used together. [dev-console]: https://console.developers.google.com/project [gce-how-to]: https://developers.google.com/compute/docs/authentication#using diff --git a/docs/overview.html b/docs/overview.html deleted file mode 100644 index 4ecf3cf568b..00000000000 --- a/docs/overview.html +++ /dev/null @@ -1,23 +0,0 @@ -

    - First, install google-cloud with npm and require it into your project: -

    -
    $ npm install --save google-cloud
    -
    var gcloud = require('google-cloud');
    -

    - If you are running your app on Google Compute Engine, you won't need to worry about supplying connection configuration options to gcloud-node— we figure that out for you. -

    -

    - However, if you're running your app elsewhere, you will need to provide project details to authenticate API requests. -

    -
    -// Compute Engine -var gcloud = require('google-cloud'); - -// Elsewhere -var gcloud = require('google-cloud')({ - projectId: 'project-id', - keyFilename: '/path/to/keyfile.json' -});
    -

    - The full set of options which can be passed to gcloud-node and sub-modules are outlined here. -

    diff --git a/docs/toc.json b/docs/toc.json deleted file mode 100644 index 4559bf6387e..00000000000 --- a/docs/toc.json +++ /dev/null @@ -1,205 +0,0 @@ -{ - "overview": "overview.html", - "guides": [{ - "title": "Authentication", - "id": "authentication", - "edit": "https://github.com/GoogleCloudPlatform/gcloud-common/edit/master/authentication/readme.md", - "contents": [ - "https://raw.githubusercontent.com/GoogleCloudPlatform/gcloud-common/master/authentication/readme.md", - "authentication.md" - ] - }, { - "title": "FAQ", - "id": "faq", - "edit": "https://github.com/GoogleCloudPlatform/gcloud-common/edit/master/faq/readme.md", - "contents": [ - "https://raw.githubusercontent.com/GoogleCloudPlatform/gcloud-common/master/faq/readme.md", - "faq.md" - ] - }, { - "title": "Troubleshooting", - "id": "troubleshooting", - "edit": "https://github.com/GoogleCloudPlatform/gcloud-common/edit/master/troubleshooting/readme.md", - "contents": [ - "https://raw.githubusercontent.com/GoogleCloudPlatform/gcloud-common/master/troubleshooting/readme.md", - "troubleshooting.md" - ] - }, { - "title": "Contributing", - "id": "contributing", - "edit": "https://github.com/GoogleCloudPlatform/gcloud-common/edit/master/contributing/readme.md", - "contents": "https://raw.githubusercontent.com/GoogleCloudPlatform/gcloud-common/master/contributing/readme.md" - }], - "services": [{ - "title": "gcloud", - "type": "gcloud" - }, { - "title": "BigQuery", - "type": "bigquery", - "nav": [{ - "title": "Dataset", - "type": "bigquery/dataset" - }, { - "title": "Table", - "type": "bigquery/table" - }, { - "title": "Job", - "type": "bigquery/job" - }] - }, { - "title": "Bigtable", - "type": "bigtable", - "nav": [{ - "title": "Table", - "type": "bigtable/table" - }, { - "title": "Family", - "type": "bigtable/family" - }, { - "title": "Row", - "type": "bigtable/row" - }, { - "title": "Filter", - "type": "bigtable/filter" - }] - }, { - "title": "Compute", - "type": "compute", - "nav": [{ - "title": "Address", - "type": "compute/address" - }, { - "title": "Autoscaler", - "type": "compute/autoscaler" - }, { - "title": "Disk", - "type": "compute/disk" - }, { - "title": "Firewall", - "type": "compute/firewall" - }, { - "title": "HealthCheck", - "type": "compute/health-check" - }, { - "title": "InstanceGroup", - "type": "compute/instance-group" - }, { - "title": "MachineType", - "type": "compute/machine-type" - }, { - "title": "Network", - "type": "compute/network" - }, { - "title": "Operation", - "type": "compute/operation" - }, { - "title": "Region", - "type": "compute/region" - }, { - "title": "Rule", - "type": "compute/rule" - }, { - "title": "Service", - "type": "compute/service" - }, { - "title": "Snapshot", - "type": "compute/snapshot" - }, { - "title": "Subnetwork", - "type": "compute/subnetwork" - }, { - "title": "VM", - "type": "compute/vm" - }, { - "title": "Zone", - "type": "compute/zone" - }] - }, { - "title": "DNS", - "type": "dns", - "nav": [{ - "title": "Zone", - "type": "dns/zone" - }, { - "title": "Record", - "type": "dns/record" - }, { - "title": "Change", - "type": "dns/change" - }] - }, { - "title": "Datastore", - "type": "datastore", - "nav": [{ - "title": "Query", - "type": "datastore/query" - }, { - "title": "Transaction", - "type": "datastore/transaction" - }] - }, { - }, { - "title": "Language", - "type": "language", - "nav": [{ - "title": "Document", - "type": "language/document" - }] - }, { - "title": "Logging", - "type": "logging", - "nav": [{ - "title": "Sink", - "type": "logging/sink" - }, { - "title": "Log", - "type": "logging/log" - }, { - "title": "Entry", - "type": "logging/entry" - }] - }, { - "title": "Prediction", - "type": "prediction", - "nav": [{ - "title": "Model", - "type": "prediction/model" - }] - }, { - "title": "PubSub", - "type": "pubsub", - "nav": [{ - "title": "Topic", - "type": "pubsub/topic" - }, { - "title": "Subscription", - "type": "pubsub/subscription" - }] - }, { - "title": "Resource", - "type": "resource", - "nav": [{ - "title": "Project", - "type": "resource/project" - }] - }, { - "title": "Storage", - "type": "storage", - "nav": [{ - "title": "Bucket", - "type": "storage/bucket" - }, { - "title": "File", - "type": "storage/file" - }, { - "title": "Channel", - "type": "storage/channel" - }] - }, { - "title": "Translate", - "type": "translate" - }, { - "title": "Vision", - "type": "vision" - }] -} From 18d33a75c4df692c99220e17e554e625d9fdbbcf Mon Sep 17 00:00:00 2001 From: Dave Gramlich Date: Thu, 11 Aug 2016 13:29:12 -0400 Subject: [PATCH 05/10] added comment to bundle script --- scripts/docs/bundle.js | 3 +++ 1 file changed, 3 insertions(+) diff --git a/scripts/docs/bundle.js b/scripts/docs/bundle.js index df543f3773a..fcdba004163 100644 --- a/scripts/docs/bundle.js +++ b/scripts/docs/bundle.js @@ -26,6 +26,9 @@ var flatten = require('lodash.flatten'); var parser = require('./parser'); var config = require('./config'); +// since we version the JSON in ghpages and we don't create tags for +// individual modules, we'll look for the appropriate semver version in +// the ghpages submodule var JSON_DIR = './ghpages/json'; var pkgJson = require('../../packages/google-cloud/package.json'); From cf71adf534959d0df92aeb057812a676b24477bb Mon Sep 17 00:00:00 2001 From: Dave Gramlich Date: Thu, 11 Aug 2016 13:29:39 -0400 Subject: [PATCH 06/10] added package name argument to publish command --- packages/bigquery/package.json | 2 +- packages/bigtable/package.json | 2 +- packages/common/package.json | 2 +- packages/compute/package.json | 2 +- packages/datastore/package.json | 2 +- packages/dns/package.json | 2 +- packages/google-cloud/package.json | 2 +- packages/language/package.json | 2 +- packages/logging/package.json | 2 +- packages/prediction/package.json | 2 +- packages/pubsub/package.json | 2 +- packages/resource/package.json | 2 +- packages/storage/package.json | 2 +- packages/translate/package.json | 2 +- packages/vision/package.json | 2 +- 15 files changed, 15 insertions(+), 15 deletions(-) diff --git a/packages/bigquery/package.json b/packages/bigquery/package.json index 7f813064a51..a39b92df288 100644 --- a/packages/bigquery/package.json +++ b/packages/bigquery/package.json @@ -68,7 +68,7 @@ "proxyquire": "^1.7.10" }, "scripts": { - "publish": "node ../../scripts/publish.js", + "publish": "node ../../scripts/publish.js bigquery", "test": "mocha test/*.js", "system-test": "mocha system-test/*.js --no-timeouts --bail" }, diff --git a/packages/bigtable/package.json b/packages/bigtable/package.json index 7a380de3344..cad829fe52c 100644 --- a/packages/bigtable/package.json +++ b/packages/bigtable/package.json @@ -74,7 +74,7 @@ "sinon": "^1.17.4" }, "scripts": { - "publish": "node ../../scripts/publish.js", + "publish": "node ../../scripts/publish.js bigtable", "test": "mocha test/*.js", "system-test": "mocha system-test/*.js --no-timeouts --bail" }, diff --git a/packages/common/package.json b/packages/common/package.json index 3816df460d7..12c0066fdc1 100644 --- a/packages/common/package.json +++ b/packages/common/package.json @@ -66,7 +66,7 @@ "sinon": "^1.17.4" }, "scripts": { - "publish": "node ../../scripts/publish.js", + "publish": "node ../../scripts/publish.js common", "test": "mocha test/*.js" }, "license": "Apache-2.0", diff --git a/packages/compute/package.json b/packages/compute/package.json index 8f98df196da..c54c67ee47c 100644 --- a/packages/compute/package.json +++ b/packages/compute/package.json @@ -67,7 +67,7 @@ "proxyquire": "^1.7.10" }, "scripts": { - "publish": "node ../../scripts/publish.js", + "publish": "node ../../scripts/publish.js compute", "test": "mocha test/*.js", "system-test": "mocha system-test/*.js --no-timeouts --bail" }, diff --git a/packages/datastore/package.json b/packages/datastore/package.json index 2c5b85981c6..a263e973f87 100644 --- a/packages/datastore/package.json +++ b/packages/datastore/package.json @@ -70,7 +70,7 @@ "through2": "^2.0.0" }, "scripts": { - "publish": "node ../../scripts/publish.js", + "publish": "node ../../scripts/publish.js datastore", "test": "mocha test/*.js", "system-test": "mocha system-test/*.js --no-timeouts --bail" }, diff --git a/packages/dns/package.json b/packages/dns/package.json index d9c654e05f5..ca4758e0222 100644 --- a/packages/dns/package.json +++ b/packages/dns/package.json @@ -66,7 +66,7 @@ "tmp": "0.0.27" }, "scripts": { - "publish": "../../scripts/publish", + "publish": "../../scripts/publish dns", "test": "mocha test/*.js", "system-test": "mocha system-test/*.js --no-timeouts --bail" }, diff --git a/packages/google-cloud/package.json b/packages/google-cloud/package.json index cf285cd1c31..2b6bbcac640 100644 --- a/packages/google-cloud/package.json +++ b/packages/google-cloud/package.json @@ -112,7 +112,7 @@ "proxyquire": "^1.7.10" }, "scripts": { - "publish": "node ../../scripts/publish.js", + "publish": "node ../../scripts/publish.js google-cloud", "test": "mocha test/*.js", "system-test": "mocha system-test/*.js --no-timeouts --bail" }, diff --git a/packages/language/package.json b/packages/language/package.json index 4bc72b4e34d..1fba4ae22d4 100644 --- a/packages/language/package.json +++ b/packages/language/package.json @@ -66,7 +66,7 @@ "proxyquire": "^1.7.10" }, "scripts": { - "publish": "../../scripts/publish.sh", + "publish": "../../scripts/publish.js language", "test": "mocha test/*.js", "system-test": "mocha system-test/*.js --no-timeouts --bail" }, diff --git a/packages/logging/package.json b/packages/logging/package.json index f8446a2051d..bc6ddb27e9c 100644 --- a/packages/logging/package.json +++ b/packages/logging/package.json @@ -69,7 +69,7 @@ "proxyquire": "^1.7.10" }, "scripts": { - "publish": "node ../../scripts/publish.js", + "publish": "node ../../scripts/publish.js logging", "test": "mocha test/*.js", "system-test": "mocha system-test/*.js --no-timeouts --bail" }, diff --git a/packages/prediction/package.json b/packages/prediction/package.json index 4ed3f077fad..edca3058bec 100644 --- a/packages/prediction/package.json +++ b/packages/prediction/package.json @@ -69,7 +69,7 @@ "proxyquire": "^1.7.10" }, "scripts": { - "publish": "node ../../scripts/publish.js", + "publish": "node ../../scripts/publish.js prediction", "test": "mocha test/*.js", "system-test": "mocha system-test/*.js --no-timeouts --bail" }, diff --git a/packages/pubsub/package.json b/packages/pubsub/package.json index 4f00494edaa..e363592c103 100644 --- a/packages/pubsub/package.json +++ b/packages/pubsub/package.json @@ -64,7 +64,7 @@ "proxyquire": "^1.7.10" }, "scripts": { - "publish": "node ../../scripts/publish.js", + "publish": "node ../../scripts/publish.js pubsub", "test": "mocha test/*.js", "system-test": "mocha system-test/*.js --no-timeouts --bail" }, diff --git a/packages/resource/package.json b/packages/resource/package.json index 7c9ddda01bd..5ab801acfbc 100644 --- a/packages/resource/package.json +++ b/packages/resource/package.json @@ -61,7 +61,7 @@ "proxyquire": "^1.7.10" }, "scripts": { - "publish": "node ../../scripts/publish.js", + "publish": "node ../../scripts/publish.js resource", "test": "mocha test/*.js", "system-test": "mocha system-test/*.js --no-timeouts --bail" }, diff --git a/packages/storage/package.json b/packages/storage/package.json index e9ac01ca2d8..b33ffea7181 100644 --- a/packages/storage/package.json +++ b/packages/storage/package.json @@ -78,7 +78,7 @@ "tmp": "0.0.27" }, "scripts": { - "publish": "node ../../scripts/publish.js", + "publish": "node ../../scripts/publish.js storage", "test": "mocha test/*.js", "system-test": "mocha system-test/*.js --no-timeouts --bail" }, diff --git a/packages/translate/package.json b/packages/translate/package.json index dddacb796b9..9b1659a3380 100644 --- a/packages/translate/package.json +++ b/packages/translate/package.json @@ -61,7 +61,7 @@ "proxyquire": "^1.7.10" }, "scripts": { - "publish": "node ../../scripts/publish.js", + "publish": "node ../../scripts/publish.js translate", "test": "mocha test/*.js", "system-test": "mocha system-test/*.js --no-timeouts --bail" }, diff --git a/packages/vision/package.json b/packages/vision/package.json index b482877cbe3..7e13fa7a321 100644 --- a/packages/vision/package.json +++ b/packages/vision/package.json @@ -71,7 +71,7 @@ "tmp": "0.0.27" }, "scripts": { - "publish": "node ../../scripts/publish.js", + "publish": "node ../../scripts/publish.js vision", "test": "mocha test/*.js", "system-test": "mocha system-test/*.js --no-timeouts --bail" }, From 78fef07d8143d6c65de75bc818d618899d7aaa85 Mon Sep 17 00:00:00 2001 From: Dave Gramlich Date: Thu, 11 Aug 2016 13:36:01 -0400 Subject: [PATCH 07/10] updated dev dependencies --- package.json | 1 + 1 file changed, 1 insertion(+) diff --git a/package.json b/package.json index 0f9a7b78b01..cf7e719ce85 100644 --- a/package.json +++ b/package.json @@ -12,6 +12,7 @@ "jshint": "^2.9.1", "lodash.template": "^4.3.0", "mitm": "^1.1.0", + "mkdirp": "^0.5.1", "mocha": "^3.0.1", "propprop": "^0.3.0", "proxyquire": "^1.7.10", From bf408fa1dfea9e7cb6c4fff8fa5e2a0990577ca4 Mon Sep 17 00:00:00 2001 From: Dave Gramlich Date: Thu, 11 Aug 2016 14:38:13 -0400 Subject: [PATCH 08/10] updating release script --- scripts/release.sh | 20 ++++++++++++++------ 1 file changed, 14 insertions(+), 6 deletions(-) diff --git a/scripts/release.sh b/scripts/release.sh index 1bbf1e378b9..8b753810137 100755 --- a/scripts/release.sh +++ b/scripts/release.sh @@ -24,12 +24,20 @@ npm run system-test git config --global user.name "travis-ci" git config --global user.email "travis@travis-ci.org" +if [[ ${TRAVIS_TAG} == *"-"* ]]; then + MODULE_NAME=${TRAVIS_TAG%-*} + MODULE_VERSION=${TRAVIS_TAG##*-} +else + MODULE_NAME="google-cloud" + MODULE_VERSION=${TRAVIS_TAG} +fi + ## Attempt to update docs/manifest.json with the new version. git submodule add -f -b master https://${GH_OAUTH_TOKEN}@github.com/${GH_OWNER}/${GH_PROJECT_NAME} master cd master node -e " -module = require('./docs/manifest.json').modules[0] -if (module.versions.indexOf('${TRAVIS_TAG}') === -1) module.versions.unshift('${TRAVIS_TAG}') +module = require('./docs/manifest.json').modules.filter(function(mod) { return mod.id === '${MODULE_NAME}'; })[0]; +if (module.versions.indexOf('${MODULE_VERSION}') === -1) module.versions.unshift('${MODULE_VERSION}') require('fs').writeFileSync('docs/manifest.json', JSON.stringify(file, null, 2) + '\n') " # allow "git add" to fail if there aren't new files. @@ -47,15 +55,15 @@ cd ../ ## Upload the docs to gh-pages. git submodule add -f -b gh-pages https://${GH_OAUTH_TOKEN}@github.com/${GH_OWNER}/${GH_PROJECT_NAME} ghpages -test -d "ghpages/json/google-cloud/${TRAVIS_TAG}" && exit 0 || mkdir ghpages/json/google-cloud/${TRAVIS_TAG} -cp docs/*.md ghpages/json/google-cloud/${TRAVIS_TAG} +test -d "ghpages/json/${MODULE_NAME}/${MODULE_VERSION}" && exit 0 || mkdir ghpages/json/${MODULE_NAME}/${MODULE_VERSION} +cp docs/*.md ghpages/json/${MODULE_NAME}/${MODULE_VERSION} +cp -R docs/json/${MODULE_NAME}/master/* ghpages/json/${MODULE_NAME}/${MODULE_VERSION} npm run bundle -cp -R ghpages/json/google-cloud/master ghpages/json/google-cloud/${TRAVIS_TAG} cp docs/home.html ghpages/json cp docs/manifest.json ghpages cd ghpages git add json git add manifest.json -git commit -m "Update docs for ${TRAVIS_TAG}" +git commit -m "Update docs for ${MODULE_NAME} ${MODULE_VERSION}" git status git push https://${GH_OAUTH_TOKEN}@github.com/${GH_OWNER}/${GH_PROJECT_NAME} HEAD:gh-pages From 9f27415230e05f6a8c4074c698180a01dcd74f95 Mon Sep 17 00:00:00 2001 From: Dave Gramlich Date: Thu, 11 Aug 2016 14:59:07 -0400 Subject: [PATCH 09/10] updating publish script --- scripts/publish.js | 45 +++++++++++++++++++++++++++++++++++++-------- 1 file changed, 37 insertions(+), 8 deletions(-) diff --git a/scripts/publish.js b/scripts/publish.js index 4424d4d8d58..f77713ad6da 100755 --- a/scripts/publish.js +++ b/scripts/publish.js @@ -28,14 +28,43 @@ cp(path.join(__dirname, '../AUTHORS'), cwd); cp(path.join(__dirname, '../CONTRIBUTORS'), cwd); cp(path.join(__dirname, '../COPYING'), cwd); -// Publish the module -exec('echo "npm publish ."', { +var args = process.argv.splice(1); +var moduleName = args[1]; +var newVersion = args[2]; +var tagName = [moduleName, newVersion].join('-'); + +if (moduleName === 'google-cloud') { + tagName = newVersion; +} + +// Create a git tag +exec('git tag -a ' + tagName + ' -m "' + moduleName + ' release for ' + newVersion + '"', { + cwd: cwd +}); + +// Increment the version +exec('npm --no-git-tag-version version ' + newVersion, { cwd: cwd }); -// Remove the duplicated files -rm([ - path.join(cwd, 'AUTHORS'), - path.join(cwd, 'CONTRIBUTORS'), - path.join(cwd, 'COPYING') -]); +console.log('Publishing package in 10 seconds. Exit process to abort'); + +setTimeout(function() { + console.log('Publishing now'); + + // Publish the module + exec('npm publish', { + cwd: cwd + }); + + exec('echo "Now push to master: git push origin master --follow-tags"', { + cwd: cwd + }); + + // Remove the duplicated files + rm([ + path.join(cwd, 'AUTHORS'), + path.join(cwd, 'CONTRIBUTORS'), + path.join(cwd, 'COPYING') + ]); +}, 10000); From 1cb844711fda0c74c4d62fc1359d31a319381652 Mon Sep 17 00:00:00 2001 From: Dave Gramlich Date: Thu, 11 Aug 2016 15:00:20 -0400 Subject: [PATCH 10/10] changing echo to console.log --- scripts/publish.js | 4 +--- 1 file changed, 1 insertion(+), 3 deletions(-) diff --git a/scripts/publish.js b/scripts/publish.js index f77713ad6da..3e1c57e50d5 100755 --- a/scripts/publish.js +++ b/scripts/publish.js @@ -57,9 +57,7 @@ setTimeout(function() { cwd: cwd }); - exec('echo "Now push to master: git push origin master --follow-tags"', { - cwd: cwd - }); + console.log('echo "Now push to master: git push origin master --follow-tags"'); // Remove the duplicated files rm([