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

Update documentation for prost remote plugins #69

Merged
merged 2 commits into from
Jun 30, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
8 changes: 4 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,21 +43,21 @@ remote plugin.
```yaml
version: v1
plugins:
- remote: buf.build/prost/plugins/prost:v0.2.1-1
- plugin: buf.build/community/neoeinstein-prost:v0.2.2
out: gen/src
opt:
- bytes=.
- compile_well_known_types
- extern_path=.google.protobuf=::pbjson_types
- file_descriptor_set
- remote: buf.build/prost/plugins/serde:v0.2.1-1
- plugin: buf.build/community/neoeinstein-prost-serde:v0.2.3
out: gen/src
- remote: buf.build/prost/plugins/tonic:v0.2.1-1
- plugin: buf.build/community/neoeinstein-tonic:v0.2.2
out: gen/src
opt:
- compile_well_known_types
- extern_path=.google.protobuf=::pbjson_types
- name: prost-crate
- plugin: prost-crate
out: gen
strategy: all
opt:
Expand Down
8 changes: 4 additions & 4 deletions example/build-with-buf/buf.gen.yaml
Original file line number Diff line number Diff line change
@@ -1,20 +1,20 @@
version: v1
plugins:
- name: prost
- plugin: prost
out: src/gen
opt:
# - bytes=.
- compile_well_known_types
- extern_path=.google.protobuf=::pbjson_types
- file_descriptor_set
- name: prost-serde
- plugin: prost-serde
out: src/gen
- name: tonic
- plugin: tonic
out: src/gen
opt:
- compile_well_known_types
- extern_path=.google.protobuf=::pbjson_types
- name: prost-crate
- plugin: prost-crate
out: .
strategy: all
opt:
Expand Down
8 changes: 4 additions & 4 deletions proto/buf.gen.yaml
Original file line number Diff line number Diff line change
@@ -1,20 +1,20 @@
version: v1
plugins:
- name: prost
- plugin: prost
out: gen/src
opt:
- bytes=.
- compile_well_known_types
- extern_path=.google.protobuf=::pbjson_types
- file_descriptor_set
- name: prost-serde
- plugin: prost-serde
out: gen/src
- name: tonic
- plugin: tonic
out: gen/src
opt:
- compile_well_known_types
- extern_path=.google.protobuf=::pbjson_types
- name: prost-crate
- plugin: prost-crate
out: gen
strategy: all
opt:
Expand Down
18 changes: 9 additions & 9 deletions protoc-gen-prost-crate/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -73,7 +73,7 @@ directory without any conditional compilation feature flags:
```yaml
version: v1
plugins:
- name: prost-crate
- plugin: prost-crate
out: gen
strategy: all
opt:
Expand All @@ -86,12 +86,12 @@ into the `src` directory which will be created by this plugin:
```yaml
version: v1
plugins:
- name: prost
- plugin: prost
out: gen/src
opt:
- bytes=.
- file_descriptor_set
- name: prost-crate
- plugin: prost-crate
out: gen
strategy: all
opt:
Expand All @@ -105,12 +105,12 @@ put into the include file, used the `only_include` option:
```yaml
version: v1
plugins:
- name: prost
- plugin: prost
out: gen/src
opt:
- bytes=.
- file_descriptor_set
- name: prost-crate
- plugin: prost-crate
out: gen
strategy: all
opt:
Expand All @@ -125,12 +125,12 @@ for use. Note that the remote plugin form is _not compatible_ with the `gen_crat
option, as the plugin is executed outside the context of the current file system,
so template information cannot be used. The plugin is referenced as follows:

[1]: https://buf.build/prost/plugins/crate
[1]: https://buf.build/community/neoeinstein-prost-crate

```yaml
version: v1
plugins:
- remote: buf.build/prost/plugins/crate:v0.3.1-1
- plugin: buf.build/community/neoeinstein-prost-crate:v0.3.1
out: gen
```

Expand Down Expand Up @@ -223,12 +223,12 @@ prost = "0.10.0"
```yaml
version: v1
plugins:
- name: prost
- plugin: prost
out: src
opt:
- bytes=.
- file_descriptor_set
- name: prost-crate
- plugin: prost-crate
out: gen
strategy: all
opt:
Expand Down
14 changes: 7 additions & 7 deletions protoc-gen-prost-serde/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -98,12 +98,12 @@ and `extern_path=.google.protobuf=::pbjson_types` options should be specified.
```yaml
version: v1
plugins:
- name: prost
- plugin: prost
out: gen
opt:
- compile_well_known_types
- extern_path=.google.protobuf=::pbjson_types
- name: prost-serde
- plugin: prost-serde
out: gen
```

Expand All @@ -112,12 +112,12 @@ a plugin which you can execute remotely, without needing to explicitly install
this tool. See the [plugin listing][1] to identify the latest published version
for use. The plugin is referenced as follows:

[1]: https://buf.build/prost/plugins/serde
[1]: https://buf.build/community/neoeinstein-prost-serde

```yaml
version: v1
plugins:
- remote: buf.build/prost/plugins/serde:v0.2.1-1
- plugin: buf.build/community/neoeinstein-prost-serde:v0.2.3
out: gen
```

Expand All @@ -127,14 +127,14 @@ plugin:
```yaml
version: v1
plugins:
- name: prost
- plugin: prost
out: gen
opt:
- compile_well_known_types
- extern_path=.google.protobuf=::pbjson_types
- name: prost-serde
- plugin: prost-serde
out: gen
- name: prost-crate
- plugin: prost-crate
strategy: all
out: gen
opt:
Expand Down
16 changes: 8 additions & 8 deletions protoc-gen-prost/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -71,7 +71,7 @@ When used with _buf_, options can be specified in the `buf.gen.yaml` file:
```yaml
version: v1
plugins:
- name: prost
- plugin: prost
out: gen
opt:
- bytes=.
Expand All @@ -86,12 +86,12 @@ a plugin which you can execute remotely, without needing to explicitly install
this tool. See the [plugin listing][1] to identify the latest published version
for use. The plugin is referenced as follows:

[1]: https://buf.build/prost/plugins/prost
[1]: https://buf.build/community/neoeinstein-prost

```yaml
version: v1
plugins:
- remote: buf.build/prost/plugins/prost:v0.2.1-1
- plugin: buf.build/community/neoeinstein-prost:v0.2.2
out: gen
```

Expand All @@ -102,12 +102,12 @@ the `protoc-gen-prost-crate` plugin.
```yaml
version: v1
plugins:
- name: prost
- plugin: prost
out: gen/src
opt:
- bytes=.
- file_descriptor_set
- name: prost-crate
- plugin: prost-crate
out: gen
strategy: all
opt:
Expand Down Expand Up @@ -136,14 +136,14 @@ Here is an example for _buf_ using the `protoc-gen-prost-serde` plugin:
```yaml
version: v1
plugins:
- name: prost
- plugin: prost
out: gen/src
opt:
- bytes=.
- file_descriptor_set
- name: prost-serde
- plugin: prost-serde
out: gen/src
- name: prost-crate
- plugin: prost-crate
out: gen
strategy: all
opt:
Expand Down
16 changes: 8 additions & 8 deletions protoc-gen-tonic/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -101,9 +101,9 @@ When used with _buf_, options can be specified in the `buf.gen.yaml` file.
```yaml
version: v1
plugins:
- name: prost
- plugin: prost
out: gen
- name: tonic
- plugin: tonic
out: gen
```

Expand All @@ -115,12 +115,12 @@ a plugin which you can execute remotely, without needing to explicitly install
this tool. See the [plugin listing][1] to identify the latest published version
for use. The plugin is referenced as follows:

[1]: https://buf.build/prost/plugins/tonic
[1]: https://buf.build/community/neoeinstein-tonic

```yaml
version: v1
plugins:
- remote: buf.build/prost/plugins/tonic:v0.2.1-1
- plugin: buf.build/community/neoeinstein-tonic:v0.2.2
out: gen
```

Expand All @@ -132,19 +132,19 @@ or use the client.
```yaml
version: v1
plugins:
- name: prost
- plugin: prost
out: gen/src
opt:
- compile_well_known_types
- extern_path=.google.protobuf=::pbjson_types
- name: prost-serde
- plugin: prost-serde
out: gen/src
- name: tonic
- plugin: tonic
out: gen/src
opt:
- compile_well_known_types
- extern_path=.google.protobuf=::pbjson_types
- name: prost
- plugin: prost
out: gen
opt:
- gen_crate=Cargo.toml.tpl
Expand Down
2 changes: 1 addition & 1 deletion protoc-wkt/buf.gen.yaml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
version: v1
plugins:
- name: prost
- plugin: prost
out: src/gen
opt:
- file_descriptor_set
18 changes: 0 additions & 18 deletions publish_buf.sh

This file was deleted.