Skip to content

Commit

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

* 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

Co-authored-by: sofisl <55454395+sofisl@users.noreply.github.com>
  • Loading branch information
yoshi-automation and sofisl authored Jan 12, 2021
1 parent 17b97e6 commit 5769b3a
Show file tree
Hide file tree
Showing 2 changed files with 16 additions and 5 deletions.
15 changes: 13 additions & 2 deletions packages/google-cloud-managedidentities/CONTRIBUTING.md
Original file line number Diff line number Diff line change
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 Managed Service for Microsoft Active Directory 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=managedidentities.googleapis.com
[auth]: https://cloud.google.com/docs/authentication/getting-started
6 changes: 3 additions & 3 deletions packages/google-cloud-managedidentities/synth.metadata
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,8 @@
{
"git": {
"name": ".",
"remote": "git@github.com:googleapis/nodejs-managed-identities.git",
"sha": "41216f2a3f75d8ec9c18074e0eef4df1c3122b05"
"remote": "https://github.com/googleapis/nodejs-managed-identities.git",
"sha": "09a59a901ff9fc97b3e9accbd8434306fe8ed603"
}
},
{
Expand All @@ -19,7 +19,7 @@
"git": {
"name": "synthtool",
"remote": "https://github.com/googleapis/synthtool.git",
"sha": "18c5dbdb4ac8cf75d4d8174e7b4558f48e76f8a1"
"sha": "363fe305e9ce34a6cd53951c6ee5f997094b54ee"
}
}
],
Expand Down

0 comments on commit 5769b3a

Please sign in to comment.