Skip to content
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

Merged
merged 2 commits into from
Dec 13, 2022

Conversation

suztomo
Copy link
Member

@suztomo suztomo commented Dec 13, 2022

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.

@suztomo suztomo requested review from a team as code owners December 13, 2022 16:21
@@ -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
Copy link
Member Author

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.

@suztomo suztomo requested a review from alicejli December 13, 2022 16:23
Copy link
Contributor

@alicejli alicejli left a 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.
Copy link
Contributor

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

Copy link
Member Author

@suztomo suztomo Dec 13, 2022

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
Copy link
Collaborator

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.

Copy link
Member Author

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.

@sonarqubecloud
Copy link

Kudos, SonarCloud Quality Gate passed!    Quality Gate passed

Bug A 0 Bugs
Vulnerability A 0 Vulnerabilities
Security Hotspot A 0 Security Hotspots
Code Smell A 0 Code Smells

No Coverage information No Coverage information
No Duplication information No Duplication information

@suztomo suztomo merged commit 079d830 into googleapis:main Dec 13, 2022
@suztomo suztomo deleted the development_doc branch December 13, 2022 20:50
suztomo added a commit that referenced this pull request Dec 16, 2022
* docs: development with local gapic-generator-java

* adding instruction for arbitrary target
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants