Skip to content
This repository was archived by the owner on Apr 3, 2024. It is now read-only.

Commit b4001f4

Browse files
docs: add instructions for authenticating for system tests (#938)
This PR was generated using Autosynth. 🌈 Synth log will be available here: https://source.cloud.google.com/results/invocations/f858a143-daac-4e50-b9ae-219abe9981ce/targets - [ ] To automatically regenerate this PR, check this box. Source-Link: googleapis/synthtool@363fe30
1 parent 7d0dcc6 commit b4001f4

File tree

3 files changed

+15
-6
lines changed

3 files changed

+15
-6
lines changed

CONTRIBUTING.md

+12-2
Original file line numberDiff line numberDiff line change
@@ -37,6 +37,14 @@ accept your pull requests.
3737
1. Title your pull request following [Conventional Commits](https://www.conventionalcommits.org/) styling.
3838
1. Submit a pull request.
3939

40+
### Before you begin
41+
42+
1. [Select or create a Cloud Platform project][projects].
43+
1. [Enable the Stackdriver Debugger API][enable_api].
44+
1. [Set up authentication with a service account][auth] so you can access the
45+
API from your local workstation.
46+
47+
4048
## Running the tests
4149

4250
1. [Prepare your environment for Node.js setup][setup].
@@ -51,15 +59,17 @@ accept your pull requests.
5159
npm test
5260

5361
# Run sample integration tests.
54-
gcloud auth application-default login
5562
npm run samples-test
5663

5764
# Run all system tests.
58-
gcloud auth application-default login
5965
npm run system-test
6066

6167
1. Lint (and maybe fix) any changes:
6268

6369
npm run fix
6470

6571
[setup]: https://cloud.google.com/nodejs/docs/setup
72+
[projects]: https://console.cloud.google.com/project
73+
[billing]: https://support.google.com/cloud/answer/6293499#enable-billing
74+
[enable_api]: https://console.cloud.google.com/flows/enableapi?apiid=clouddebugger.googleapis.com
75+
[auth]: https://cloud.google.com/docs/authentication/getting-started

README.md

+1-2
Original file line numberDiff line numberDiff line change
@@ -58,8 +58,7 @@ npm install @google-cloud/debug-agent
5858

5959
## Samples
6060

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

6463
| Sample | Source Code | Try it |
6564
| --------------------------- | --------------------------------- | ------ |

synth.metadata

+2-2
Original file line numberDiff line numberDiff line change
@@ -4,14 +4,14 @@
44
"git": {
55
"name": ".",
66
"remote": "https://github.com/googleapis/cloud-debug-nodejs.git",
7-
"sha": "29443eba84cf4f76e70718b88948fc23b14725d2"
7+
"sha": "7d0dcc6cd5d52d2ca6e131ddf3b70c219acc365e"
88
}
99
},
1010
{
1111
"git": {
1212
"name": "synthtool",
1313
"remote": "https://github.com/googleapis/synthtool.git",
14-
"sha": "15013eff642a7e7e855aed5a29e6e83c39beba2a"
14+
"sha": "363fe305e9ce34a6cd53951c6ee5f997094b54ee"
1515
}
1616
}
1717
]

0 commit comments

Comments
 (0)