Skip to content

Commit

Permalink
docs: add instructions for authenticating for system tests (#1369)
Browse files Browse the repository at this point in the history
* docs: add instructions for authenticating for system tests

* docs: add phrasing change to README

Source-Author: sofisl <55454395+sofisl@users.noreply.github.com>
Source-Date: Mon Dec 21 13:21:29 2020 -0800
Source-Repo: googleapis/synthtool
Source-Sha: 363fe305e9ce34a6cd53951c6ee5f997094b54ee
Source-Link: googleapis/synthtool@363fe30
  • Loading branch information
yoshi-automation committed Dec 22, 2020
1 parent fb04f78 commit 365fd5c
Show file tree
Hide file tree
Showing 3 changed files with 16 additions and 6 deletions.
15 changes: 13 additions & 2 deletions CONTRIBUTING.md
Expand Up @@ -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 Storage 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].
Expand All @@ -51,15 +60,17 @@ 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:

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=storage-api.googleapis.com
[auth]: https://cloud.google.com/docs/authentication/getting-started
3 changes: 1 addition & 2 deletions README.md
Expand Up @@ -91,8 +91,7 @@ createBucket().catch(console.error);

## Samples

Samples are in the [`samples/`](https://github.com/googleapis/nodejs-storage/tree/master/samples) directory. The samples' `README.md`
has instructions for running the samples.
Samples are in the [`samples/`](https://github.com/googleapis/nodejs-storage/tree/master/samples) directory. Each sample's `README.md` has instructions for running its sample.

| Sample | Source Code | Try it |
| --------------------------- | --------------------------------- | ------ |
Expand Down
4 changes: 2 additions & 2 deletions synth.metadata
Expand Up @@ -4,14 +4,14 @@
"git": {
"name": ".",
"remote": "https://github.com/googleapis/nodejs-storage.git",
"sha": "7c6dcbbc81fc7da98eb0c62d6e109e83797f6fdd"
"sha": "fb04f782c4aa9b5430713f569687102d098bac1f"
}
},
{
"git": {
"name": "synthtool",
"remote": "https://github.com/googleapis/synthtool.git",
"sha": "15013eff642a7e7e855aed5a29e6e83c39beba2a"
"sha": "363fe305e9ce34a6cd53951c6ee5f997094b54ee"
}
}
]
Expand Down

0 comments on commit 365fd5c

Please sign in to comment.