Skip to content

Commit

Permalink
Update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
Dinonard committed Sep 10, 2024
1 parent 1f7a0a4 commit f16fe5f
Showing 1 changed file with 17 additions and 1 deletion.
18 changes: 17 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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.
Expand Down

0 comments on commit f16fe5f

Please sign in to comment.