From f16fe5f8b97c8460c2f53da82433c316cb43102a Mon Sep 17 00:00:00 2001 From: Dino Pacandi Date: Tue, 10 Sep 2024 17:00:14 +0200 Subject: [PATCH] Update readme --- README.md | 18 +++++++++++++++++- 1 file changed, 17 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index a95a84d5cb..978afcd3ea 100644 --- a/README.md +++ b/README.md @@ -40,7 +40,7 @@ $ cd Astar # compile the node # note: you may encounter some errors if `wasm32-unknown-unknown` is not installed, or if the toolchain channel is outdated -$ cargo build --release +$ cargo build --profile production # show list of available commands $ ./target/release/astar-collator --help @@ -85,6 +85,22 @@ $ curl -H 'Content-Type: application/json' --data '{ "jsonrpc":"2.0", "method":" After this step, you should have a validator node online with a session key for your node. For key management and validator rewards, consult our [validator guide online](https://docs.astar.network/build/validator-guide/configure-node). +## Versioning + +Up to the release `v5.44.0`, **Astar** releases contained both the client & the runtime blobs. +In general, each release contained both, with some specific releases (related to fixes) which only released e.g. client or runtime. +Standard semantic versioning approach was used. + +The new approach will see the split of client & runtime releases. + +The **client release** will continue to follow semantic versioning, continuing where the former approach left off. +E.g. the next expected minor release will be `v5.45.0`. + +The **runtime release** will follow a new versioning approach - `runtime-XXYY`. + +* The `XX` part will be a number of 2 or more digits, starting with **10**, and will be incremented by **1** each time a new runtime release is made. E.g. `runtime-1000` will be followed by `runtime-1100`, which will be followed by `runtime-1200`, and so on. This is like a combination of _major_ and _minor_ semver versions. +* The `YY` part will always be a 2 digit number, and serves as a _patch_ semver version. E.g. if we have `runtime-1000` and need to release a fix, the new release version will be `runtime-1001`. + ## Workspace Dependency Handling All dependencies should be listed inside the workspace's root `Cargo.toml` file.