From 248ae74369444486d08b32eec594c4f8ef62a8d7 Mon Sep 17 00:00:00 2001 From: Yoshi Automation Bot Date: Tue, 22 Dec 2020 11:46:07 -0800 Subject: [PATCH] docs: add instructions for authenticating for system tests (#360) This PR was generated using Autosynth. :rainbow: Synth log will be available here: https://source.cloud.google.com/results/invocations/e893c041-f585-44a0-8a3b-f1f3eee08f43/targets - [ ] To automatically regenerate this PR, check this box. Source-Link: https://github.com/googleapis/synthtool/commit/363fe305e9ce34a6cd53951c6ee5f997094b54ee --- .../google-cloud-resourcemanager/CONTRIBUTING.md | 15 +++++++++++++-- packages/google-cloud-resourcemanager/README.md | 3 +-- .../google-cloud-resourcemanager/synth.metadata | 4 ++-- 3 files changed, 16 insertions(+), 6 deletions(-) diff --git a/packages/google-cloud-resourcemanager/CONTRIBUTING.md b/packages/google-cloud-resourcemanager/CONTRIBUTING.md index f6c4cf010e34..da2f730c973c 100644 --- a/packages/google-cloud-resourcemanager/CONTRIBUTING.md +++ b/packages/google-cloud-resourcemanager/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 Google Cloud Resource Manager API 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=cloudresourcemanager.googleapis.com +[auth]: https://cloud.google.com/docs/authentication/getting-started \ No newline at end of file diff --git a/packages/google-cloud-resourcemanager/README.md b/packages/google-cloud-resourcemanager/README.md index 7ce4120495df..0043f91ed03c 100644 --- a/packages/google-cloud-resourcemanager/README.md +++ b/packages/google-cloud-resourcemanager/README.md @@ -87,8 +87,7 @@ quickstart(); ## Samples -Samples are in the [`samples/`](https://github.com/googleapis/nodejs-resource/tree/master/samples) directory. The samples' `README.md` -has instructions for running the samples. +Samples are in the [`samples/`](https://github.com/googleapis/nodejs-resource/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-resourcemanager/synth.metadata b/packages/google-cloud-resourcemanager/synth.metadata index d95243ae0ca7..dd5451331cb1 100644 --- a/packages/google-cloud-resourcemanager/synth.metadata +++ b/packages/google-cloud-resourcemanager/synth.metadata @@ -4,14 +4,14 @@ "git": { "name": ".", "remote": "https://github.com/googleapis/nodejs-resource.git", - "sha": "25d6722e196833e75c96401f0ee81ed3f98c105e" + "sha": "295d9c2e5d91b9b4bfce8d34a99a4a0c955a38e8" } }, { "git": { "name": "synthtool", "remote": "https://github.com/googleapis/synthtool.git", - "sha": "15013eff642a7e7e855aed5a29e6e83c39beba2a" + "sha": "363fe305e9ce34a6cd53951c6ee5f997094b54ee" } } ]