Skip to content

Commit

Permalink
docs: update docs for v5.1.1 release (#2100)
Browse files Browse the repository at this point in the history
* 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>
  • Loading branch information
sainoe and p-offtermatt authored Jul 29, 2024
1 parent 9048d17 commit 2be3936
Show file tree
Hide file tree
Showing 8 changed files with 27 additions and 24 deletions.
1 change: 0 additions & 1 deletion .changelog/unreleased/summary.md

This file was deleted.

1 change: 1 addition & 0 deletions .changelog/v5.1.1/summary.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
*July 26, 2024*
16 changes: 16 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -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*
Expand Down
21 changes: 4 additions & 17 deletions RELEASE_NOTES.md
Original file line number Diff line number Diff line change
@@ -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.

<!-- Add the following line for major or minor releases -->
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.
10 changes: 5 additions & 5 deletions UPGRADING.md
Original file line number Diff line number Diff line change
@@ -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.

Expand Down
2 changes: 1 addition & 1 deletion docs/docs/upgrading/migrate_v4_v5.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down

0 comments on commit 2be3936

Please sign in to comment.