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.

Sign up for GitHub

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
Merged

docs: development with local gapic-generator-java #1132

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
c51e51b
docs: development with local gapic-generator-java
suztomo Dec 13, 2022
83d2607
adding instruction for arbitrary target
suztomo Dec 13, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
55 changes: 48 additions & 7 deletions DEVELOPMENT.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.

[gapic-showcase](https://github.com/googleapis/gapic-showcase/).

2. Copy the protos from Showcase into googleapis/google/showcase.
2. Copy the protos from Showcase into googleapis/google/showcase.

```sh
mkdir googleapis/google/showcase
cp -r gapic-showcase/schema/google/showcase/v1beta1 googleapis/google/showcase/v1beta1
```

3. Add the new microgenerator rules to
3. Add the new microgenerator rules to
`googleapis/google/showcase/v1beta1/BUILD.bazel` file as follows:

```python
Expand Down Expand Up @@ -162,8 +162,49 @@
)
```

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.


Normally, googleapis's build pulls in googleapis/gapic-generator-java from the
Internet:

```
# Java microgenerator.
…
_gapic_generator_java_version = "2.1.0"

http_archive(
name = "gapic_generator_java",
…
urls = ["https://github.com/googleapis/gapic-generator-java/archive/v%s.zip" % _gapic_generator_java_version],
)
```

By replacing this portion using the built-in local_repository rule, you can mak
it refer to your local development repo:

```
local_repository(
name = "gapic_generator_java",
path = "/home/<your id>/gapic-generator-java",
)
```

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 •
edited
Loading

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


```sh
cd googleapis
bazel build //google/showcase/v1beta1:showcase_java_gapic
```

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 service's `BUILD.bazel` file.
For instance, to run your local generator on the `speech`'s v2 service, you can
run:

```
bazel build //google/cloud/speech/v2:google-cloud-speech-v2-java
```



```sh
bazel build //google/showcase/v1beta1:showcase_java_gapic
```