Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add badges with the release info to the README.md #5518

Merged
merged 5 commits into from
Sep 4, 2024
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 7 additions & 19 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,27 +38,15 @@ curl --proto '=https' --tlsv1.2 -sSf https://raw.githubusercontent.com/paritytec

## 🚀 Releases

> [!NOTE]
> Our release process is still Work-In-Progress and may not yet reflect the aspired outline
> here.

The Polkadot-SDK has two release channels: `stable` and `nightly`. Production software is advised to
only use `stable`. `nightly` is meant for tinkerers to try out the latest features. The detailed
release process is described in [RELEASE.md](docs/RELEASE.md).

You can use [`psvm`](https://github.com/paritytech/psvm) to manage your Polkadot-SDK dependency
versions in downstream projects.

### 😌 Stable

`stable` releases have a support duration of **three months**. In this period, the release will not
have any breaking changes. It will receive bug fixes, security fixes, performance fixes and new
non-breaking features on a **two week** cadence.
<!-- markdownlint-disable-next-line MD013 -->
![Current Stable Release](https://raw.githubusercontent.com/paritytech/release-registry/main/badges/polkadot-sdk-latest.svg)&nbsp;&nbsp;![Next Stable Release](https://raw.githubusercontent.com/paritytech/release-registry/main/badges/polkadot-sdk-next.svg)

### 🤠 Nightly
The Polkadot-SDK is released every three months as a `stableYYMMDD` release. They are supported for
one year with patches. See the next upcoming versions in the [Release
Registry](https://github.com/paritytech/release-registry/).

`nightly` releases are released every night from the `master` branch, potentially with breaking
changes. They have pre-release version numbers in the format `major.0.0-nightlyYYMMDD`.
You can use [`psvm`](https://github.com/paritytech/psvm) to update all dependencies to a specific
version without needing to manually select the correct version for each crate.

## 🛠️ Tooling

Expand Down