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

chore(release): 19.1.0 #1478

Merged
merged 2 commits into from
Aug 15, 2024
Merged

chore(release): 19.1.0 #1478

merged 2 commits into from
Aug 15, 2024

Conversation

Imod7
Copy link
Contributor

@Imod7 Imod7 commented Aug 15, 2024

Description

This is a minor release for Sidecar since:

  • it includes features and updates in docs and dependencies and
  • in the pjs and non pjs deps no breaking change was identified

Notes

In the compatibility section (CHANGELOG), I reverted the node version in the previous format. Also, added in parenthesis the node release in the format (vX.XX.XX) as it appears on the Polkadot releases page to avoid any confusion.

@Imod7 Imod7 requested a review from a team as a code owner August 15, 2024 12:12
CHANGELOG.md Outdated
## Compatibility

Tested against:
- Polkadot v11500 (v1.15.0 / stable2407)
Copy link
Member

Choose a reason for hiding this comment

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

If these are referring to specVersion, I thought it was v1015000 same for the below v1013000

Copy link
Contributor

@IkerAlus IkerAlus Aug 15, 2024

Choose a reason for hiding this comment

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

I am not sure it makes sense to talk about spec version here. These versions will never hit Polkadot or Kusama runtimes.

I think we need to be more precise and tell apart between the Polkadot-SDK node release and the versions hitting Polkadot, Kusama, and Westend RCs.

Copy link
Member

Choose a reason for hiding this comment

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

Yea that definitely makes sense! I agree probably best to just mention the latest live polkadot kusama and westend runtimes.

Copy link
Contributor Author

@Imod7 Imod7 Aug 15, 2024

Choose a reason for hiding this comment

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

Yes, regarding the compatibility versioning. So, as you know I changed the formatting in the last release here and my reasoning was the following:

I noticed that in the section Assets of v1.13.0 release notes, some assets are labeled as v1013000, e.g. asset-hub-rococo_runtime-v1013000.compact.compressed.wasm so I think this is the correct way to denote the client version.

However, I had doubts now if this is the ideal way to represent the node version so I reverted back to how it used to be, so 11500. The reasons are the following :

  • 11500 looks more compact
  • 11500 is the formatting we used until now so I thought it is best to keep it and in case of doubts I now add the version in x.x.x format
  • 1015000 has the same formatting as the runtime and I thought that it might cause confusion.

Having said that, if you think my previous change was better then I will go back to the v1015000 format. I think a good idea is to also change the title from Compatibility to Node Compatibility.

Copy link
Contributor

@IkerAlus IkerAlus Aug 15, 2024

Choose a reason for hiding this comment

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

In terms of node compatibility, I am all good with that @Imod7 said in the last comment.

What it is not so clear to me is what to do with runtime compatibility. When runtimes and node releases were split, we didn't make any differentiation in the release notes but I think it makes sense to mention compatibility with runtimes too. Bear in mind that runtime releases for Westend are contained in the Polkadot-SDK release, so it would be something like:

Compatibility

  • Tested against the following node releases:

    • Polkadot v1.15.0
    • Kusama v1.15.0
    • Westend v1.15.0
  • Tested against the following runtime releases:

    • Polkadot v1002007
    • Kusama v1002006
    • Westend v1015000

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 really like this actually. Super clear and leaves no room for confusion 💯 Thank you! I will change it now.

Copy link
Contributor Author

@Imod7 Imod7 Aug 15, 2024

Choose a reason for hiding this comment

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

Changed it here:

  • I also added (Polkadot stable2407) next to the node releases so it is aligned with the p-sdk releases page.
  • I was thinking of making it even more clear by adding the corresponding links but then for Westend it will be confusing.

Copy link
Member

@TarikGul TarikGul left a comment

Choose a reason for hiding this comment

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

lgtm

@Imod7 Imod7 requested a review from IkerAlus August 15, 2024 14:04
@Imod7 Imod7 merged commit beea4a7 into master Aug 15, 2024
15 checks passed
@Imod7 Imod7 deleted the domi-v19-1-0 branch August 15, 2024 14:43
This pull request was closed.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants