feat: add .repo-metadata.json and move to new README template (#636)

googleapis · Jun 1, 2019 · 11007cf · 11007cf
1 parent 6a5eb36
commit 11007cf
Show file tree

Hide file tree

Showing 11 changed files with 212 additions and 217 deletions.
diff --git a/.cloud-repo-tools.json b/.cloud-repo-tools.json
diff --git a/.gitignore b/.gitignore
@@ -14,3 +14,4 @@ google-cloud-logging-bunyan-*.tgz
 package-lock.json
 .vscode
 yarn.lock
+__pycache__
diff --git a/.readme-partials.yml b/.readme-partials.yml
@@ -0,0 +1,4 @@
+introduction: |-
+        [Cloud Spanner](https://cloud.google.com/spanner/docs/) is a fully managed, mission-critical, relational database service that
+        offers transactional consistency at global scale, schemas, SQL (ANSI 2011 with extensions),
+        and automatic, synchronous replication for high availability.
diff --git a/.repo-metadata.json b/.repo-metadata.json
@@ -0,0 +1,14 @@
+{
+  "name": "spanner",
+  "name_pretty": "Cloud Spanner",
+  "product_documentation": "https://cloud.google.com/spanner/docs/",
+  "client_documentation": "https://cloud.google.com/nodejs/docs/reference/spanner/latest/",
+  "issue_tracker": "https://issuetracker.google.com/issues?q=componentid:190851%2B%20status:open",
+  "release_level": "ga",
+  "language": "nodejs",
+  "repo": "googleapis/nodejs-spanner",
+  "distribution_name": "@google-cloud/spanner",
+  "api_id": "spanner.googleapis.com",
+  "requires_billing": true
+}
+
diff --git a/README.md b/README.md
@@ -1,21 +1,24 @@
 [//]: # "This README.md file is auto-generated, all changes to this file will be lost."
-[//]: # "To regenerate it, use `npm run generate-scaffolding`."
+[//]: # "To regenerate it, use `python -m synthtool`."
 <img src="https://avatars2.githubusercontent.com/u/2810941?v=3&s=96" alt="Google Cloud Platform logo" title="Google Cloud Platform" align="right" height="96" width="96"/>
 
 # [Cloud Spanner: Node.js Client](https://github.com/googleapis/nodejs-spanner)
 
-[![release level](https://img.shields.io/badge/release%20level-general%20availability%20%28GA%29-brightgreen.svg?style&#x3D;flat)](https://cloud.google.com/terms/launch-stages)
+[![release level](https://img.shields.io/badge/release%20level-general%20availability%20%28GA%29-brightgreen.svg?style=flat)](https://cloud.google.com/terms/launch-stages)
 [![npm version](https://img.shields.io/npm/v/@google-cloud/spanner.svg)](https://www.npmjs.org/package/@google-cloud/spanner)
 [![codecov](https://img.shields.io/codecov/c/github/googleapis/nodejs-spanner/master.svg?style=flat)](https://codecov.io/gh/googleapis/nodejs-spanner)
 
-> Node.js idiomatic client for [Cloud Spanner][product-docs].
 
-[Cloud Spanner](https://cloud.google.com/spanner/docs/) is a fully managed, mission-critical, relational database service that offers transactional consistency at global scale, schemas, SQL (ANSI 2011 with extensions), and automatic, synchronous replication for high availability.
+
+
+[Cloud Spanner](https://cloud.google.com/spanner/docs/) is a fully managed, mission-critical, relational database service that
+offers transactional consistency at global scale, schemas, SQL (ANSI 2011 with extensions),
+and automatic, synchronous replication for high availability.
 
 
 * [Cloud Spanner Node.js Client API Reference][client-docs]
-* [github.com/googleapis/nodejs-spanner](https://github.com/googleapis/nodejs-spanner)
 * [Cloud Spanner Documentation][product-docs]
+* [github.com/googleapis/nodejs-spanner](https://github.com/googleapis/nodejs-spanner)
 
 Read more about the client libraries for Cloud APIs, including the older
 Google APIs Client Libraries, in [Client Libraries Explained][explained].
@@ -24,6 +27,7 @@ Google APIs Client Libraries, in [Client Libraries Explained][explained].
 
 **Table of contents:**
 
+
 * [Quickstart](#quickstart)
   * [Before you begin](#before-you-begin)
   * [Installing the client library](#installing-the-client-library)
@@ -37,83 +41,64 @@ Google APIs Client Libraries, in [Client Libraries Explained][explained].
 
 ### Before you begin
 
-1.  Select or create a Cloud Platform project.
+1.  [Select or create a Cloud Platform project][projects].
+1.  [Enable billing for your project][billing].
+1.  [Enable the Cloud Spanner API][enable_api].
+1.  [Set up authentication with a service account][auth] so you can access the
+    API from your local workstation.
 
-    [Go to the projects page][projects]
+### Installing the client library
 
-1.  Enable billing for your project.
+```bash
+npm install @google-cloud/spanner
+```
 
-    [Enable billing][billing]
 
-1.  Enable the Cloud Spanner API.
+### Using the client library
 
-    [Enable the API][enable_api]
+```javascript
+  // Imports the Google Cloud client library
+  const {Spanner} = require('@google-cloud/spanner');
 
-1.  [Set up authentication with a service account][auth] so you can access the
-    API from your local workstation.
+  // Creates a client
+  const spanner = new Spanner({projectId});
 
-[projects]: https://console.cloud.google.com/project
-[billing]: https://support.google.com/cloud/answer/6293499#enable-billing
-[enable_api]: https://console.cloud.google.com/flows/enableapi?apiid=spanner.googleapis.com
-[auth]: https://cloud.google.com/docs/authentication/getting-started
+  // Gets a reference to a Cloud Spanner instance and database
+  const instance = spanner.instance(instanceId);
+  const database = instance.database(databaseId);
 
-### Installing the client library
+  // The query to execute
+  const query = {
+    sql: 'SELECT 1',
+  };
 
-    npm install --save @google-cloud/spanner
+  // Execute a simple SQL statement
+  const [rows] = await database.run(query);
+  console.log(`Query: ${rows.length} found.`);
+  rows.forEach(row => console.log(row));
 
-### Using the client library
-
-```javascript
-// Imports the Google Cloud client library
-const {Spanner} = require('@google-cloud/spanner');
-
-// Your Google Cloud Platform project ID
-const projectId = 'YOUR_PROJECT_ID';
-
-// Creates a client
-const spanner = new Spanner({
-  projectId: projectId,
-});
-
-// Your Cloud Spanner instance ID
-const instanceId = 'my-instance';
-
-// Your Cloud Spanner database ID
-const databaseId = 'my-database';
-
-// Gets a reference to a Cloud Spanner instance and database
-const instance = spanner.instance(instanceId);
-const database = instance.database(databaseId);
-
-// The query to execute
-const query = {
-  sql: 'SELECT 1',
-};
-
-// Execute a simple SQL statement
-database
-  .run(query)
-  .then(results => {
-    const rows = results[0];
-
-    rows.forEach(row => console.log(row));
-  })
-  .catch(err => {
-    console.error('ERROR:', err);
-  });
 ```
 
+
+
 ## Samples
 
 Samples are in the [`samples/`](https://github.com/googleapis/nodejs-spanner/tree/master/samples) directory. The samples' `README.md`
 has instructions for running the samples.
 
 | Sample                      | Source Code                       | Try it |
 | --------------------------- | --------------------------------- | ------ |
-| Schema | [source code](https://github.com/googleapis/nodejs-spanner/blob/master/samples/schema.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/nodejs-spanner&page=editor&open_in_editor=samples/schema.js,samples/README.md) |
+| Batch | [source code](https://github.com/googleapis/nodejs-spanner/blob/master/samples/batch.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/nodejs-spanner&page=editor&open_in_editor=samples/batch.js,samples/README.md) |
 | CRUD | [source code](https://github.com/googleapis/nodejs-spanner/blob/master/samples/crud.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/nodejs-spanner&page=editor&open_in_editor=samples/crud.js,samples/README.md) |
+| DML | [source code](https://github.com/googleapis/nodejs-spanner/blob/master/samples/dml.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/nodejs-spanner&page=editor&open_in_editor=samples/dml.js,samples/README.md) |
 | Indexing | [source code](https://github.com/googleapis/nodejs-spanner/blob/master/samples/indexing.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/nodejs-spanner&page=editor&open_in_editor=samples/indexing.js,samples/README.md) |
-| Transactions | [source code](https://github.com/googleapis/nodejs-spanner/blob/master/samples/transaction.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/nodejs-spanner&page=editor&open_in_editor=samples/transaction.js,samples/README.md) |
+| Quickstart | [source code](https://github.com/googleapis/nodejs-spanner/blob/master/samples/quickstart.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/nodejs-spanner&page=editor&open_in_editor=samples/quickstart.js,samples/README.md) |
+| Schema | [source code](https://github.com/googleapis/nodejs-spanner/blob/master/samples/schema.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/nodejs-spanner&page=editor&open_in_editor=samples/schema.js,samples/README.md) |
+| Struct | [source code](https://github.com/googleapis/nodejs-spanner/blob/master/samples/struct.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/nodejs-spanner&page=editor&open_in_editor=samples/struct.js,samples/README.md) |
+| Timestamp | [source code](https://github.com/googleapis/nodejs-spanner/blob/master/samples/timestamp.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/nodejs-spanner&page=editor&open_in_editor=samples/timestamp.js,samples/README.md) |
+| Transaction | [source code](https://github.com/googleapis/nodejs-spanner/blob/master/samples/transaction.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/nodejs-spanner&page=editor&open_in_editor=samples/transaction.js,samples/README.md) |
+
+
 
 The [Cloud Spanner Node.js Client API Reference][client-docs] documentation
 also contains samples.
@@ -122,12 +107,17 @@ also contains samples.
 
 This library follows [Semantic Versioning](http://semver.org/).
 
+
 This library is considered to be **General Availability (GA)**. This means it
 is stable; the code surface will not change in backwards-incompatible ways
 unless absolutely necessary (e.g. because of critical security issues) or with
 an extensive deprecation period. Issues and requests against **GA** libraries
 are addressed with the highest priority.
 
+
+
+
+
 More Information: [Google Cloud Platform Launch Stages][launch_stages]
 
 [launch_stages]: https://cloud.google.com/terms/launch-stages
@@ -145,4 +135,7 @@ See [LICENSE](https://github.com/googleapis/nodejs-spanner/blob/master/LICENSE)
 [client-docs]: https://cloud.google.com/nodejs/docs/reference/spanner/latest/
 [product-docs]: https://cloud.google.com/spanner/docs/
 [shell_img]: https://gstatic.com/cloudssh/images/open-btn.png
-
+[projects]: https://console.cloud.google.com/project
+[billing]: https://support.google.com/cloud/answer/6293499#enable-billing
+[enable_api]: https://console.cloud.google.com/flows/enableapi?apiid=spanner.googleapis.com
+[auth]: https://cloud.google.com/docs/authentication/getting-started
diff --git a/package.json b/package.json
@@ -32,7 +32,6 @@
   "scripts": {
     "docs": "jsdoc -c .jsdoc.js",
     "predocs": "npm run compile",
-    "generate-scaffolding": "repo-tools generate all && repo-tools generate lib_samples_readme -l samples/ --config ../.cloud-repo-tools.json",
     "lint": "eslint samples/ && gts check",
     "samples-test": "cd samples/ && npm link ../ && npm test && cd ../",
     "system-test": "mocha build/system-test --timeout 600000",