This repository was archived by the owner on Feb 15, 2026. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 17
[CHANGE ME] Re-generated to pick up changes in the API or client library generator. #149
Closed
Closed
Changes from all commits
Commits
Show all changes
3 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,37 +1,57 @@ | ||
| ## Adding a new API | ||
|
|
||
| If a new API exists on `googleapis`, but is not yet available through `google-proto-files`, there is one decision to make before you proceed. Do you want to add a shortcut to it? A shortcut looks like: | ||
|
|
||
| ```js | ||
| const googleProtoFiles = require('google-proto-files') | ||
|
|
||
| // Shortcut: | ||
| const datastorev1 = googleProtoFiles.datastore.v1 | ||
|
|
||
| // Without shortcut: | ||
| const datastorev1 = googleProtoFiles('datastore/v1/datastore.proto') | ||
| ``` | ||
|
|
||
| ### ✔️ Shortcut | ||
|
|
||
| - Edit `index.js`, following the convention that exists in the file already. | ||
| - Edit `test/index.test.js`, again following the convention that exists in the file already. | ||
| - Run the tests: | ||
| ```sh | ||
| $ npm test | ||
| ``` | ||
| - Commit the changes | ||
| - Publish the module: | ||
| ```sh | ||
| $ npm version minor | ||
| $ npm publish | ||
| $ git push origin master --follow-tags | ||
| ``` | ||
|
|
||
| ### ❌ Shortcut | ||
|
|
||
| ```sh | ||
| $ npm version patch | ||
| $ npm publish | ||
| $ git push origin master --follow-tags | ||
| ``` | ||
| # How to become a contributor and submit your own code | ||
|
|
||
| **Table of contents** | ||
|
|
||
| * [Contributor License Agreements](#contributor-license-agreements) | ||
| * [Contributing a patch](#contributing-a-patch) | ||
| * [Running the tests](#running-the-tests) | ||
| * [Releasing the library](#releasing-the-library) | ||
|
|
||
| ## Contributor License Agreements | ||
|
|
||
| We'd love to accept your sample apps and patches! Before we can take them, we | ||
| have to jump a couple of legal hurdles. | ||
|
|
||
| Please fill out either the individual or corporate Contributor License Agreement | ||
| (CLA). | ||
|
|
||
| * If you are an individual writing original source code and you're sure you | ||
| own the intellectual property, then you'll need to sign an [individual CLA] | ||
| (https://developers.google.com/open-source/cla/individual). | ||
| * If you work for a company that wants to allow you to contribute your work, | ||
| then you'll need to sign a [corporate CLA] | ||
| (https://developers.google.com/open-source/cla/corporate). | ||
|
|
||
| Follow either of the two links above to access the appropriate CLA and | ||
| instructions for how to sign and return it. Once we receive it, we'll be able to | ||
| accept your pull requests. | ||
|
|
||
| ## Contributing A Patch | ||
|
|
||
| 1. Submit an issue describing your proposed change to the repo in question. | ||
| 1. The repo owner will respond to your issue promptly. | ||
| 1. If your proposed change is accepted, and you haven't already done so, sign a | ||
| Contributor License Agreement (see details above). | ||
| 1. Fork the desired repo, develop and test your code changes. | ||
| 1. Ensure that your code adheres to the existing style in the code to which | ||
| you are contributing. | ||
| 1. Ensure that your code has an appropriate set of tests which all pass. | ||
| 1. Submit a pull request. | ||
|
|
||
| ## Running the tests | ||
|
|
||
| 1. [Prepare your environment for Node.js setup][setup]. | ||
|
|
||
| 1. Install dependencies: | ||
|
|
||
| npm install | ||
|
|
||
| 1. Run the tests: | ||
|
|
||
| npm test | ||
|
|
||
| 1. Lint (and maybe fix) any changes: | ||
|
|
||
| npm run fix | ||
|
|
||
| [setup]: https://cloud.google.com/nodejs/docs/setup | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@JustinBeckwith @kinwa91 this had some custom help for this repo. Should we skip this PR, or somehow append the new stuff without erasing the old?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yeah - would you mind adding this to the ignored files in the synth file?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Sure. How?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Pretty much like this: https://github.com/googleapis/google-api-nodejs-client/blob/master/synth.py#L27
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks! #154