-
Notifications
You must be signed in to change notification settings - Fork 53
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
docs: development with local gapic-generator-java #1132
Conversation
@@ -97,17 +97,17 @@ | |||
|
|||
## Running the Plugin | |||
|
|||
1. Clone [googleapis](https://github.com/googleapis/googleapis) and | |||
1. Clone [googleapis](https://github.com/googleapis/googleapis) and |
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.
My IntelliJ tells that it was unnecessary space.
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.
Looks good, quick comment on something you may want to add.
) | ||
``` | ||
|
||
5. Build the new target. |
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.
Steps looks good; wondering if you wanted to add a step on how to build any client library (e.g. technically you don't need to build the showcase service, can build any service). Something like:
You can generate any client library based on the protos within googleapis
. You just need the name of the service within the java_gapic_assembly_gradle_pkg
rules within the services BUILD.bazel
file. For instance, if you wanted to test your local generator on the speech
service, you can run:
bazel build google-cloud-speech-v1-java
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.
Good. I added 83d2607 with bazel build //google/cloud/speech/v2:google-cloud-speech-v2-java
@@ -162,8 +162,36 @@ | |||
) | |||
``` | |||
|
|||
4. Build the new target. | |||
4. Point to local gapic-generator-java |
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 Tomo! It's good to have a section that points to local repo, just be aware that this section will change very soon once we merge #918. We will point googleapis to a local jar instead of a path to local repo.
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.
That sounds good. Not a blocker for this pull request.
Kudos, SonarCloud Quality Gate passed! |
* docs: development with local gapic-generator-java * adding instruction for arbitrary target
Adding a step to use gapic-generator-java in local computer.
Credit: @chanseokoh 's "How does gapic-generator-java (“Java Microgenerator”) fit into the Cloud library generation workflow?" documentation.