From 2be3936e843fdc879a62e8f599bee64dc9a79f0e Mon Sep 17 00:00:00 2001 From: Simon Noetzlin Date: Mon, 29 Jul 2024 13:34:42 +0200 Subject: [PATCH] docs: update docs for v5.1.1 release (#2100) * update changelog and release notes for v5.1.1 * generate changelog * Update RELEASE_NOTES.md Co-authored-by: Philip Offtermatt <57488781+p-offtermatt@users.noreply.github.com> * nits --------- Co-authored-by: Philip Offtermatt <57488781+p-offtermatt@users.noreply.github.com> --- .changelog/unreleased/summary.md | 1 - .../provider/2095-proto-message-fix.md | 0 .../provider/2095-proto-message-fix.md | 0 .changelog/v5.1.1/summary.md | 1 + CHANGELOG.md | 16 ++++++++++++++ RELEASE_NOTES.md | 21 ++++--------------- UPGRADING.md | 10 ++++----- docs/docs/upgrading/migrate_v4_v5.md | 2 +- 8 files changed, 27 insertions(+), 24 deletions(-) delete mode 100644 .changelog/unreleased/summary.md rename .changelog/{unreleased => v5.1.1}/api-breaking/provider/2095-proto-message-fix.md (100%) rename .changelog/{unreleased => v5.1.1}/state-breaking/provider/2095-proto-message-fix.md (100%) create mode 100644 .changelog/v5.1.1/summary.md diff --git a/.changelog/unreleased/summary.md b/.changelog/unreleased/summary.md deleted file mode 100644 index aea175d241..0000000000 --- a/.changelog/unreleased/summary.md +++ /dev/null @@ -1 +0,0 @@ -*July 19, 2024* diff --git a/.changelog/unreleased/api-breaking/provider/2095-proto-message-fix.md b/.changelog/v5.1.1/api-breaking/provider/2095-proto-message-fix.md similarity index 100% rename from .changelog/unreleased/api-breaking/provider/2095-proto-message-fix.md rename to .changelog/v5.1.1/api-breaking/provider/2095-proto-message-fix.md diff --git a/.changelog/unreleased/state-breaking/provider/2095-proto-message-fix.md b/.changelog/v5.1.1/state-breaking/provider/2095-proto-message-fix.md similarity index 100% rename from .changelog/unreleased/state-breaking/provider/2095-proto-message-fix.md rename to .changelog/v5.1.1/state-breaking/provider/2095-proto-message-fix.md diff --git a/.changelog/v5.1.1/summary.md b/.changelog/v5.1.1/summary.md new file mode 100644 index 0000000000..02e8a8b342 --- /dev/null +++ b/.changelog/v5.1.1/summary.md @@ -0,0 +1 @@ +*July 26, 2024* diff --git a/CHANGELOG.md b/CHANGELOG.md index ce4147ce69..503e13c020 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,5 +1,21 @@ # CHANGELOG +## v5.1.1 + +*July 26, 2024* + +### API BREAKING + +- [Provider](x/ccv/provider) + - Fix incorrect message defitions in the proto files of the provider module + ([\#2095](https://github.com/cosmos/interchain-security/pull/2095)) + +### STATE BREAKING + +- [Provider](x/ccv/provider) + - Fix incorrect message defitions in the proto files of the provider module + ([\#2095](https://github.com/cosmos/interchain-security/pull/2095)) + ## v5.1.0 *July 19, 2024* diff --git a/RELEASE_NOTES.md b/RELEASE_NOTES.md index b390ecfacd..d0e71928d8 100644 --- a/RELEASE_NOTES.md +++ b/RELEASE_NOTES.md @@ -1,26 +1,13 @@ -# Replicated Security v5.1.0 Release Notes +# Replicated Security v5.1.1 Release Notes ## 📝 Changelog -Check out the [changelog](https://github.com/cosmos/interchain-security/blob/v5.1.0/CHANGELOG.md) for a list of relevant changes or [compare all changes](https://github.com/cosmos/interchain-security/compare/v4.3.1...v5.1.0) from last release. +Check out the [changelog](https://github.com/cosmos/interchain-security/blob/v5.1.1/CHANGELOG.md) for a list of relevant changes or [compare all changes](https://github.com/cosmos/interchain-security/compare/v5.1.0...v5.1.1) from last release. Refer to the [upgrading guide](https://github.com/cosmos/interchain-security/blob/release/v5.1.x/UPGRADING.md) when migrating from `v4.3.x` to `v5.1.x`. ## 🚀 Highlights -Cosmos SDK v0.50 upgrade: - -* (deps) [\#2013](https://github.com/cosmos/interchain-security/pull/2013) Bump multiple dependencies. - * Bump Cosmos-SDK to v0.50.8. - * Bump IBC-Go to v8.3.2. - * Bump CometBFT to v0.38.9. - -API-breaking change: - -* (feat) [\#1998](https://github.com/cosmos/interchain-security/pull/1998) Change the UX of the provider's - [key assignment feature](docs/docs/features/key-assignment.md) to return an error if a validator - tries to reuse the same consumer key. - -* (feat) [\#1995](https://github.com/cosmos/interchain-security/pull/1995) Deprecate the - [Soft opt-out Feature](docs/docs/adrs/adr-009-soft-opt-out.md). +API- and state-breaking change: +This release fixes some bugs found in the message definitions of the provider module, see [\#2095](https://github.com/cosmos/interchain-security/pull/2095) for more details. diff --git a/UPGRADING.md b/UPGRADING.md index 1f25aa3d08..a9de7407ed 100644 --- a/UPGRADING.md +++ b/UPGRADING.md @@ -1,20 +1,20 @@ # Upgrading Replicated Security -## [v5.1.x](https://github.com/cosmos/interchain-security/releases/tag/v5.1.0) +## [v5.1.x](https://github.com/cosmos/interchain-security/releases/tag/v5.1.1) ### Provider -***Note that providers using v5.0.0 cannot upgrade to v5.1.0 cleanly*** +***Note that providers using v5.0.0 cannot upgrade to v5.1.1 cleanly*** -Providers using versions `v4.0.x`, `v4.1.x`, `v4.2.x`, `v4.3.x` and `v4.4.x` can upgrade to `v5.1.0`. +Providers using versions `v4.0.x`, `v4.1.x`, `v4.2.x`, `v4.3.x` and `v4.4.x` can upgrade to `v5.1.1`. -Upgrading from `v4.x` to `v5.1.0` will upgrade the provider `consensus version` to 7. +Upgrading from `v4.x` to `v5.1.1` will upgrade the provider `consensus version` to 7. Upgrade code will be executed automatically during the upgrade procedure. ### Consumer -Upgrading the consumer from `v5.0.0` to `v5.1.0` will not require state migration. +Upgrading the consumer from `v5.0.0` to `v5.1.1` will not require state migration. This guide provides instructions for upgrading to specific versions of Replicated Security. diff --git a/docs/docs/upgrading/migrate_v4_v5.md b/docs/docs/upgrading/migrate_v4_v5.md index bdec036804..35fe60c124 100644 --- a/docs/docs/upgrading/migrate_v4_v5.md +++ b/docs/docs/upgrading/migrate_v4_v5.md @@ -21,7 +21,7 @@ Pre-requisite version for this upgrade: any from the `v4.x` release line. `v5.0.0` should not be used on the provider. -The provider should be updated to `v5.1.0`. +The provider should be updated to `v5.1.1`. ## Provider