Skip to content

Commit 9f4eb4e

Browse files
docs: add instructions for authenticating for system tests (#141)
This PR was generated using Autosynth. 🌈 Synth log will be available here: https://source.cloud.google.com/results/invocations/28ef5920-505e-44eb-bad6-0e53fa99adef/targets - [ ] To automatically regenerate this PR, check this box. Source-Link: googleapis/synthtool@363fe30
1 parent b4e6c03 commit 9f4eb4e

File tree

3 files changed

+16
-6
lines changed

3 files changed

+16
-6
lines changed

packages/google-monitoring-dashboard/CONTRIBUTING.md

+13-2
Original file line numberDiff line numberDiff line change
@@ -37,6 +37,15 @@ 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 billing for your project][billing].
44+
1. [Enable the Monitoring Dashboards API][enable_api].
45+
1. [Set up authentication with a service account][auth] so you can access the
46+
API from your local workstation.
47+
48+
4049
## Running the tests
4150

4251
1. [Prepare your environment for Node.js setup][setup].
@@ -51,15 +60,17 @@ accept your pull requests.
5160
npm test
5261

5362
# Run sample integration tests.
54-
gcloud auth application-default login
5563
npm run samples-test
5664

5765
# Run all system tests.
58-
gcloud auth application-default login
5966
npm run system-test
6067

6168
1. Lint (and maybe fix) any changes:
6269

6370
npm run fix
6471

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

packages/google-monitoring-dashboard/README.md

+1-2
Original file line numberDiff line numberDiff line change
@@ -85,8 +85,7 @@ listDashboards();
8585

8686
## Samples
8787

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

9190
| Sample | Source Code | Try it |
9291
| --------------------------- | --------------------------------- | ------ |

packages/google-monitoring-dashboard/synth.metadata

+2-2
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
"git": {
55
"name": ".",
66
"remote": "https://github.com/googleapis/nodejs-monitoring-dashboards.git",
7-
"sha": "59f8013b20dc37873eb75462b67abf0d38d95b88"
7+
"sha": "984fa800a0f2c3f7a44649f9d9493c9be4a5f89e"
88
}
99
},
1010
{
@@ -19,7 +19,7 @@
1919
"git": {
2020
"name": "synthtool",
2121
"remote": "https://github.com/googleapis/synthtool.git",
22-
"sha": "15013eff642a7e7e855aed5a29e6e83c39beba2a"
22+
"sha": "363fe305e9ce34a6cd53951c6ee5f997094b54ee"
2323
}
2424
}
2525
],

0 commit comments

Comments
 (0)