From b9d9cbfe2961a3789f60686cde7d53ec65d24055 Mon Sep 17 00:00:00 2001 From: Ostrzyciel Date: Thu, 12 Sep 2024 20:04:36 +0200 Subject: [PATCH] Final touches before the 1.0.0 release --- README.md | 8 +++++--- grpc.proto | 3 ++- rdf.proto | 1 + 3 files changed, 8 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 646d26d..9aa45d9 100644 --- a/README.md +++ b/README.md @@ -19,13 +19,15 @@ See the [contribution guide on the Jelly website](https://w3id.org/jelly/dev/con ## 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. +This protocol follows the [Semantic Versioning 2.0 scheme](https://semver.org/). 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](https://w3id.org/jelly/dev/specification/serialization/#versioning) for more details. ### Releases -The `dev` release tag corresponds to the main branch in the repository and is updated automatically. +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. To create a new tagged release (example for version 1.2.3): +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): ```shell git checkout main diff --git a/grpc.proto b/grpc.proto index 0cb6ac2..fb113a4 100644 --- a/grpc.proto +++ b/grpc.proto @@ -1,7 +1,8 @@ syntax = "proto3"; package eu.ostrzyciel.jelly.core.proto.v1; -// gRPC service specifications for RDF streaming. +// Jelly gRPC streaming protocol. +// Specification document: https://w3id.org/jelly/1.0.0/specification/streaming // Protocol version: 1.0.0 import "rdf.proto"; diff --git a/rdf.proto b/rdf.proto index c938ad1..1f43836 100644 --- a/rdf.proto +++ b/rdf.proto @@ -2,6 +2,7 @@ syntax = "proto3"; package eu.ostrzyciel.jelly.core.proto.v1; // Jelly RDF serialization with Protocol Buffers. +// Specification document: https://w3id.org/jelly/1.0.0/specification/serialization // Protocol version: 1.0.0 // RDF IRIs