.jelly.jelly-grpc_3.0.14.2.source-code.README.md Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of jelly-grpc_3 Show documentation
Show all versions of jelly-grpc_3 Show documentation
Implementation of a gRPC client and server for the Jelly gRPC streaming protocol.
# jelly-protobuf
Protocol Buffers and gRPC specifications for the Jelly protocol.
- `rdf.proto` – the RDF Protocol Buffers serialization only. Use this if you don't plan on using Jelly's gRPC protocol.
- `grpc.proto` – Jelly's gRPC protocol service specifications.
**[See the protocol specification on the website](https://w3id.org/jelly/latest/specification/)**
**[More information about Jelly](https://w3id.org/jelly/latest/)**
## Usage
The `rdf.proto` and `grpc.proto` files define the Jelly RDF serialization and the gRPC pub/sub service, respectively. They use the [proto 3](https://protobuf.dev/programming-guides/proto3/) language and can be used with protoc or any other compatible tool. See the [Protocol Buffers documentation](https://protobuf.dev/) for more details.
## Versioning
This protocol follows the [Semantic Versioning 2.0 scheme](https://semver.org/). The current major version is 1, and after it stabilizes, backward compatibility with it will be kept in future 1.x.y versions.
### Releases
The `dev` release tag corresponds to the main branch in the repository and is updated automatically.
Tagged (versioned) releases are created manually. To create a new tagged release (example for version 1.2.3):
```sh
git checkout main
git pull
git tag v1.2.3
git push origin v1.2.3
```
The rest (packaging and release creation) will be handled automatically by the CI.