Skip to content

Latest commit

 

History

History
43 lines (25 loc) · 1.95 KB

README.md

File metadata and controls

43 lines (25 loc) · 1.95 KB

jelly-protobuf

Protocol Buffers and gRPC specifications for the Jelly RDF serialization format and gRPC streaming 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

More information about Jelly

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 language and can be used with protoc or any other compatible tool. See the Protocol Buffers documentation for more details.

Contributing

See the contribution guide on the Jelly website.

Versioning

This protocol follows the Semantic Versioning 2.0 scheme. The current major version is 1, and backward compatibility with it will be kept in future 1.x.y versions.

The version of the protocol is embedded into all Jelly files/messages. See the protocol specification for more details.

Releases

The dev release tag corresponds to the main branch in the repository and is updated automatically after every push to this branch.

Tagged (versioned) releases are created manually. Before making a tagged release, be sure to update all mentions of the protocol version in .proto files. To create a new tagged release (example for version 1.2.3):

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.

License

The contents of this repository are licensed under the Apache 2.0 license.