Skip to content

Commit 186cfc8

Browse files
authored
docs: update docs for cutting release (#1790)
* update changelog * update release notes * updated upgrading instructions
1 parent da0d003 commit 186cfc8

File tree

6 files changed

+34
-47
lines changed

6 files changed

+34
-47
lines changed

.changelog/v4.1.0/summary.md

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1 @@
1-
<!--
2-
*March 27, 2024*
3-
-->
1+
*April 17, 2024*

CHANGELOG.md

Lines changed: 12 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,22 +2,27 @@
22

33
## v4.1.0
44

5-
<!--
6-
*March 27, 2024*
7-
-->
5+
*April 17, 2024*
86

97
### DEPENDENCIES
108

119
- Bump [cosmos-sdk](https://github.com/cosmos/cosmos-sdk) to
1210
[v0.47.10](https://github.com/cosmos/cosmos-sdk/releases/tag/v0.47.10).
1311
([\#1663](https://github.com/cosmos/interchain-security/pull/1663))
12+
- Bump [ibc-go](https://github.com/cosmos/ibc-go) to
13+
[v7.4.0](https://github.com/cosmos/ibc-go/releases/tag/v7.4.0).
14+
([\#1764](https://github.com/cosmos/interchain-security/pull/1764))
1415

1516
### FEATURES
1617

1718
- [Provider](x/ccv/provider)
1819
- Introduce epochs (i.e., send a VSCPacket every X blocks instead of in every
1920
block) so that we reduce the cost of relaying IBC packets needed for ICS.
2021
([\#1516](https://github.com/cosmos/interchain-security/pull/1516))
22+
- Introduce the gRPC query `/interchain_security/ccv/provider/oldest_unconfirmed_vsc/{chain_id}`
23+
and CLI command `interchain-security-pd q provider oldest_unconfirmed_vsc`
24+
to retrieve the send timestamp of the oldest unconfirmed VSCPacket by chain id.
25+
([\#1740](https://github.com/cosmos/interchain-security/pull/1740))
2126

2227
### IMPROVEMENTS
2328

@@ -27,6 +32,10 @@
2732

2833
### STATE BREAKING
2934

35+
- General
36+
- Bump [ibc-go](https://github.com/cosmos/ibc-go) to
37+
[v7.4.0](https://github.com/cosmos/ibc-go/releases/tag/v7.4.0).
38+
([\#1764](https://github.com/cosmos/interchain-security/pull/1764))
3039
- [Provider](x/ccv/provider)
3140
- Introduce epochs (i.e., send a VSCPacket every X blocks instead of in every
3241
block) so that we reduce the cost of relaying IBC packets needed for ICS.

RELEASE_NOTES.md

Lines changed: 7 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -1,37 +1,17 @@
1-
<!--
2-
A release notes template that should be adapted for every release
3-
- release: <v*.*.*>
4-
- release branch: <v*.x>
5-
- the last release: <v-last>
6-
- the last release branch: <v-last.x>
7-
-->
8-
9-
# Replicated Security <v*.*.*> Release Notes
1+
# Replicated Security v4.1.0 Release Notes
102

113
<!--
124
Please indicate whether this release is relevant to consumers or providers.
135
-->
14-
***Note this release is ONLY relevant to <consumers/providers>***
6+
***Note this release is ONLY relevant to providers***
157

168
## 📝 Changelog
17-
** REMOVE THE LINE BELOW TO ENABLE THE MARKDOWN LINK CHECKER FOR RELEASE **
18-
<!-- markdown-link-check-disable -->
19-
20-
Check out the [changelog](https://github.com/cosmos/interchain-security/blob/<v*.*.*>/CHANGELOG.md) for a list of relevant changes or [compare all changes](https://github.com/cosmos/interchain-security/compare/release/<v-last>...<v*.*.*>) from last release.
9+
Check out the [changelog](https://github.com/cosmos/interchain-security/blob/v4.1.0/CHANGELOG.md) for a list of relevant changes or [compare all changes](https://github.com/cosmos/interchain-security/compare/v4.0.0...v4.1.0) from last release.
2110

2211
<!-- Add the following line for major releases -->
23-
Refer to the [upgrading guide](https://github.com/cosmos/interchain-security/blob/release/<v*.x>/UPGRADING.md) when migrating from `<v-last.x>` to `<v*.x>`.
12+
Refer to the [upgrading guide](https://github.com/cosmos/interchain-security/blob/release/v4.1.x/UPGRADING.md) when migrating from `v4.0.x` to `v4.1.x`.
2413

25-
** REMOVE THE LINE BELOW TO ENABLE THE MARKDOWN LINK CHECKER FOR RELEASE **
26-
<!-- markdown-link-check-enable -->
2714
## 🚀 Highlights
28-
29-
<!-- Add any highlights of this release -->
30-
31-
## ❤️ Contributors
32-
<!-- markdown-link-check-disable -->
33-
* Informal Systems ([@informalinc](https://twitter.com/informalinc))
34-
<!-- markdown-link-check-enable -->
35-
36-
This list is non-exhaustive and ordered alphabetically.
37-
Thank you to everyone who contributed to this release!
15+
This release introduces epochs that reduce the costs of relaying IBC packets for ICS.
16+
In addition it introduces queries to retrieve the send timestamp of the oldest unconfirmed VSCPacket by chain id and
17+
for current values of all provider parameters.

UPGRADING.md

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
This guide provides instructions for upgrading to specific versions of Replicated Security.
44

5-
## [v4.1.x](https://github.com/cosmos/interchain-security/releases/tag/v4.1.0-rc2) and [v4.1.x-lsm](https://github.com/cosmos/interchain-security/releases/tag/v4.1.0-lsm-rc2)
5+
## [v4.1.x](https://github.com/cosmos/interchain-security/releases/tag/v4.1.0) and [v4.1.x-lsm](https://github.com/cosmos/interchain-security/releases/tag/v4.1.0-lsm)
66

77
### Provider
88

@@ -15,17 +15,17 @@ as well as the corresponding migrators [here](https://github.com/cosmos/intercha
1515

1616
## [v4.0.x](https://github.com/cosmos/interchain-security/tree/release/v4.0.x)
1717

18-
`v4.0.x` sets the minimum required version of Go to `1.21`, see https://github.com/cosmos/interchain-security/blob/release/v4.0.x/go.mod#L3.
18+
`v4.0.x` sets the minimum required version of Go to `1.21`, see https://github.com/cosmos/interchain-security/blob/release/v4.0.x/go.mod#L3.
1919

20-
### Provider
20+
### Provider
2121

22-
Upgrading a provider from `v3.3.0` to `v4.0.0` will require state migrations, see https://github.com/cosmos/interchain-security/blob/release/v4.0.x/x/ccv/provider/migrations/migrator.go#L31.
22+
Upgrading a provider from `v3.3.0` to `v4.0.0` will require state migrations, see https://github.com/cosmos/interchain-security/blob/release/v4.0.x/x/ccv/provider/migrations/migrator.go#L31.
2323

24-
### Consumer
24+
### Consumer
2525

26-
***Note that consumer chains can upgrade directly from `v3.1.0` to `v4.0.0`.***
26+
***Note that consumer chains can upgrade directly from `v3.1.0` to `v4.0.0`.***
2727

28-
Upgrading a consumer from `v3.2.0` to `v4.0.0` will not require state migration, however, upgrading directly from `v3.1.0` to `v4.0.0` will require state migrations, see https://github.com/cosmos/interchain-security/blob/release/v4.0.x/x/ccv/consumer/keeper/migrations.go#L22.
28+
Upgrading a consumer from `v3.2.0` to `v4.0.0` will not require state migration, however, upgrading directly from `v3.1.0` to `v4.0.0` will require state migrations, see https://github.com/cosmos/interchain-security/blob/release/v4.0.x/x/ccv/consumer/keeper/migrations.go#L22.
2929

3030
In addition, the following migration needs to be added to the upgrade handler of the consumer chain:
3131
```golang
@@ -49,15 +49,15 @@ func migrateICSOutstandingDowntime(ctx sdk.Context, keepers *upgrades.UpgradeKee
4949

5050
## [v3.3.x](https://github.com/cosmos/interchain-security/tree/release/v3.2.x)
5151

52-
### Provider
52+
### Provider
5353

54-
Upgrading the provider from `v2.x.y` to `v3.3.0` will not require state migration.
54+
Upgrading the provider from `v2.x.y` to `v3.3.0` will not require state migration.
5555

5656
## [v3.2.x](https://github.com/cosmos/interchain-security/tree/release/v3.2.x)
5757

5858
`v3.2.0` bumps IBC to `v7.3`. As a result, `legacy_ibc_testing` is not longer required and was removed, see https://github.com/cosmos/interchain-security/pull/1185. This means that when upgrading to `v3.2.0`, any customized tests relying on `legacy_ibc_testing` need to be updated.
5959

60-
### Consumer
60+
### Consumer
6161

6262
Upgrading the consumer from either `v3.0.0` or `v3.1.0` to `v3.2.0` will require state migrations, see https://github.com/cosmos/interchain-security/blob/release/v3.2.x/x/ccv/consumer/keeper/migration.go#L25.
6363

@@ -67,13 +67,13 @@ Upgrading the consumer from either `v3.0.0` or `v3.1.0` to `v3.2.0` will require
6767

6868
The following should be considered as complementary to [Cosmos SDK v0.47 UPGRADING.md](https://github.com/cosmos/cosmos-sdk/blob/v0.47.0-rc2/UPGRADING.md).
6969

70-
#### Protobuf
70+
#### Protobuf
7171

7272
Protobuf code generation, linting and formatting have been updated to leverage the `ghcr.io/cosmos/proto-builder:0.11.5` docker container. Replicated Security protobuf definitions are now packaged and published to [buf.build/cosmos/interchain-security](https://buf.build/cosmos/interchain-security) via CI workflows. The `third_party/proto` directory has been removed in favour of dependency management using [buf.build](https://docs.buf.build/introduction).
7373

7474
#### App modules
7575

76-
Legacy APIs of the `AppModule` interface have been removed from ccv modules. For example, for
76+
Legacy APIs of the `AppModule` interface have been removed from ccv modules. For example, for
7777

7878
```diff
7979
- // Route implements the AppModule interface
@@ -123,10 +123,10 @@ import (
123123

124124
## [v2.0.x](https://github.com/cosmos/interchain-security/releases/tag/v2.0.0)
125125

126-
### Provider
126+
### Provider
127127

128128
Upgrading a provider from `v1.1.0-multiden` to `v2.0.0` will require state migrations. See [migration.go](https://github.com/cosmos/interchain-security/blob/v2.0.0/x/ccv/provider/keeper/migration.go).
129129

130130
### Consumer
131131

132-
Upgrading a consumer from `v1.2.0-multiden` to `v2.0.0` will NOT require state migrations.
132+
Upgrading a consumer from `v1.2.0-multiden` to `v2.0.0` will NOT require state migrations.

0 commit comments

Comments
 (0)