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

Conversation

EgorPopelyaev
Copy link
Contributor

@EgorPopelyaev EgorPopelyaev commented Aug 29, 2024

This PR adds the badges to the readme to show the info about the current stable release version and the version and date of the upcoming stable release. The idea here to give a possibility for people from the outside to have an overview about the current and upcoming release, until we have a proper public release calendar.

Screenshot 2024-08-29 at 14 47 57

@EgorPopelyaev EgorPopelyaev added R0-silent Changes should not be mentioned in any release notes T11-documentation This PR/Issue is related to documentation. D0-easy Can be fixed primarily by duplicating and adapting code by an intermediate coder. labels Aug 29, 2024
@EgorPopelyaev EgorPopelyaev requested review from Morganamilo, a team and ggwpez August 29, 2024 10:47
README.md Outdated
@@ -38,6 +38,8 @@ curl --proto '=https' --tlsv1.2 -sSf https://raw.githubusercontent.com/paritytec

## 🚀 Releases

![Current Stable Release](https://img.shields.io/badge/Current%20Stable%20Release-polkadot_2407_1-green)  ![Next Stable Release (polkadot-2409)](https://img.shields.io/badge/Next%20Stable%20Release%20%28polkadot_2409%29-2024/09/25-orange)
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

And you want to update them manually?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

At the beginning yes, as part of the version bumps backport routine, when release is done. Later we could, probably, automate it using the release-registry as a data source

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Okay, I hope you then ensure that this happens :D

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actually, we can do this already now. Please use these URLs instead:

https://raw.githubusercontent.com/paritytech/release-registry/main/badges/polkadot-sdk-latest.svg
https://raw.githubusercontent.com/paritytech/release-registry/main/badges/polkadot-sdk-next.svg

(test if they render here)

a
b

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I've changed the URL's, looks good!

@kianenigma
Copy link
Contributor

I mentioned to @ggwpez elsewhere that the current information under the Release heading our README is probably by now not relevant, and be replaced with a link to the release registery? would be nice to do it as a part of this.

btw, the registery is super 🤌, love it.

@EgorPopelyaev
Copy link
Contributor Author

I mentioned to @ggwpez elsewhere that the current information under the Release heading our README is probably by now not relevant, and be replaced with a link to the release registery? would be nice to do it as a part of this.

btw, the registery is super 🤌, love it.

Do you mean the text part itself?
Screenshot 2024-09-04 at 12 54 58

Signed-off-by: Oliver Tale-Yazdi <[email protected]>
@ggwpez
Copy link
Member

ggwpez commented Sep 4, 2024

Screenshot 2024-09-04 at 13 43 03

Updated it. Looks like this now.

@EgorPopelyaev EgorPopelyaev added this pull request to the merge queue Sep 4, 2024
Merged via the queue into master with commit db41fab Sep 4, 2024
185 of 186 checks passed
@EgorPopelyaev EgorPopelyaev deleted the ep-add-release-badges branch September 4, 2024 13:05
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
D0-easy Can be fixed primarily by duplicating and adapting code by an intermediate coder. R0-silent Changes should not be mentioned in any release notes T11-documentation This PR/Issue is related to documentation.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants