From fbf32be5aa83335accb2348e809528ea25797a38 Mon Sep 17 00:00:00 2001 From: Yoshi Automation Bot Date: Tue, 22 Dec 2020 11:42:12 -0800 Subject: [PATCH] docs: add instructions for authenticating for system tests (#31) This PR was generated using Autosynth. :rainbow: Synth log will be available here: https://source.cloud.google.com/results/invocations/305b4f12-f9c7-4cda-8a25-0d5dc36b634b/targets - [ ] To automatically regenerate this PR, check this box. Source-Link: https://github.com/googleapis/synthtool/commit/363fe305e9ce34a6cd53951c6ee5f997094b54ee --- packages/google-cloud-aiplatform/CONTRIBUTING.md | 15 +++++++++++++-- packages/google-cloud-aiplatform/README.md | 3 +-- packages/google-cloud-aiplatform/synth.metadata | 4 ++-- 3 files changed, 16 insertions(+), 6 deletions(-) diff --git a/packages/google-cloud-aiplatform/CONTRIBUTING.md b/packages/google-cloud-aiplatform/CONTRIBUTING.md index f6c4cf010e3..0b1cde8458a 100644 --- a/packages/google-cloud-aiplatform/CONTRIBUTING.md +++ b/packages/google-cloud-aiplatform/CONTRIBUTING.md @@ -37,6 +37,15 @@ accept your pull requests. 1. Title your pull request following [Conventional Commits](https://www.conventionalcommits.org/) styling. 1. Submit a pull request. +### Before you begin + +1. [Select or create a Cloud Platform project][projects]. +1. [Enable billing for your project][billing]. +1. [Enable the AI Platform API][enable_api]. +1. [Set up authentication with a service account][auth] so you can access the + API from your local workstation. + + ## Running the tests 1. [Prepare your environment for Node.js setup][setup]. @@ -51,11 +60,9 @@ accept your pull requests. npm test # Run sample integration tests. - gcloud auth application-default login npm run samples-test # Run all system tests. - gcloud auth application-default login npm run system-test 1. Lint (and maybe fix) any changes: @@ -63,3 +70,7 @@ accept your pull requests. npm run fix [setup]: https://cloud.google.com/nodejs/docs/setup +[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=aiplatform.googleapis.com +[auth]: https://cloud.google.com/docs/authentication/getting-started \ No newline at end of file diff --git a/packages/google-cloud-aiplatform/README.md b/packages/google-cloud-aiplatform/README.md index 9b147a22349..583ce63a5b2 100644 --- a/packages/google-cloud-aiplatform/README.md +++ b/packages/google-cloud-aiplatform/README.md @@ -71,8 +71,7 @@ console.info(client); ## Samples -Samples are in the [`samples/`](https://github.com/googleapis/nodejs-ai-platform/tree/master/samples) directory. The samples' `README.md` -has instructions for running the samples. +Samples are in the [`samples/`](https://github.com/googleapis/nodejs-ai-platform/tree/master/samples) directory. Each sample's `README.md` has instructions for running its sample. | Sample | Source Code | Try it | | --------------------------- | --------------------------------- | ------ | diff --git a/packages/google-cloud-aiplatform/synth.metadata b/packages/google-cloud-aiplatform/synth.metadata index 7f3ac585c6f..071605dbef7 100644 --- a/packages/google-cloud-aiplatform/synth.metadata +++ b/packages/google-cloud-aiplatform/synth.metadata @@ -4,7 +4,7 @@ "git": { "name": ".", "remote": "https://github.com/googleapis/nodejs-ai-platform.git", - "sha": "b697a38f696ab14b3a7ce9563f2ed5449eeeab4f" + "sha": "1aaa54e2bc4829eae63736632ac25ad1c2a0c653" } }, { @@ -19,7 +19,7 @@ "git": { "name": "synthtool", "remote": "https://github.com/googleapis/synthtool.git", - "sha": "996775eca5fd934edac3c2ae34b80ff0395b1717" + "sha": "363fe305e9ce34a6cd53951c6ee5f997094b54ee" } } ],