Skip to content

Commit

Permalink
Final touches before the 1.0.0 release
Browse files Browse the repository at this point in the history
  • Loading branch information
Ostrzyciel committed Sep 12, 2024
1 parent 77ef93f commit b9d9cbf
Show file tree
Hide file tree
Showing 3 changed files with 8 additions and 4 deletions.
8 changes: 5 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
3 changes: 2 additions & 1 deletion grpc.proto
Original file line number Diff line number Diff line change
@@ -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";
Expand Down
1 change: 1 addition & 0 deletions rdf.proto
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down

0 comments on commit b9d9cbf

Please sign in to comment.