You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardexpand all lines: README.md
+1-1
Original file line number
Diff line number
Diff line change
@@ -78,7 +78,7 @@ Core Dependencies are the core libraries that an application may depend on.
78
78
79
79
#### Module Dependencies
80
80
81
-
Module Dependencies are the modules that a application may depend on and which version of the Cosmos SDK they are compatible with.
81
+
Module Dependencies are the modules that an application may depend on and which version of the Cosmos SDK they are compatible with.
82
82
83
83
> Note: The version table only goes back to 0.50.x, this is due to the reason that modules were not spun out into their own go.mods until 0.50.z. ❌ signals that the module was not spun out into its own go.mod file.
Copy file name to clipboardexpand all lines: RELEASES.md
+2-2
Original file line number
Diff line number
Diff line change
@@ -1,10 +1,10 @@
1
1
# Releases
2
2
3
-
The Cosmos-SDK follows both [0ver](https://0ver.org/) and [Semver](https://semver.org/). While this is confusing lets break it down: 0ver is used for the main Cosmos-SDK dependency (`github.com/cosmos/cosmos-sdk`) and Semver is used for all other dependencies.
3
+
The Cosmos-SDK follows both [0ver](https://0ver.org/) and [Semver](https://semver.org/). While this is confusing let's break it down: 0ver is used for the main Cosmos-SDK dependency (`github.com/cosmos/cosmos-sdk`) and Semver is used for all other dependencies.
4
4
5
5
## Semver Dependencies
6
6
7
-
Although we adhere to semantic versioning (semver), we have introduced a few modifications to accommodate the unique characteristics of blockchains. One significant divergence is that the major version (Y.x.x) is incremented solely when a consensus-breaking change occurs. On the other hand, the minor version (x.Y.x) is increased when there is a non-consensus-breaking alteration that also results in an incompatible API change. Patch versions will be bumped for all other changes that dont break the API nor Consensus.
7
+
Although we adhere to semantic versioning (semver), we have introduced a few modifications to accommodate the unique characteristics of blockchains. One significant divergence is that the major version (Y.x.x) is incremented solely when a consensus-breaking change occurs. On the other hand, the minor version (x.Y.x) is increased when there is a non-consensus-breaking alteration that also results in an incompatible API change. Patch versions will be bumped for all other changes that don't break the API nor Consensus.
* release new beta version as the bugs are discovered and fixed.
23
-
* After the team feels that the `main` works fine we create a `release/vY` branch (going forward known a release branch), where `Y` is the version number, with the patch part substituted to `x` (eg: 0.42.x, 1.0.x). Ensure the release branch is protected so that pushes against the release branch are permitted only by the release manager or release coordinator.
23
+
* After the team feels that the `main` works fine we create a `release/vY` branch (going forward known as release branch), where `Y` is the version number, with the patch part substituted to `x` (eg: 0.42.x, 1.0.x). Ensure the release branch is protected so that pushes against the release branch are permitted only by the release manager or release coordinator.
24
24
***PRs targeting this branch can be merged _only_ when exceptional circumstances arise**
25
25
* update the GitHub mergify integration by adding instructions for automatically backporting commits from `main` to the `release/vY` using the `backport/Y` label.
26
26
* In the release branch prepare a new version section in the `CHANGELOG.md`
* Remove GitHub workflows that should not be in the release branch
32
32
*`test.yml`: All standalone go module tests should be removed (expect `./simapp`, and `./tests`, SDK and modules tests).
33
33
* These packages are tracked and tested directly on main.
34
-
*`build.yml`: Only the SDK and SimApp needs to be built on release branches.
34
+
*`build.yml`: Only the SDK and SimApp need to be built on release branches.
35
35
* Tooling is tracked and tested directly on main.
36
36
* This does not apply for tooling depending on the SDK (e.g. `confix`)
37
37
* Update `Dockerfile` to not use latest go.mod and go.sum files.
@@ -66,7 +66,7 @@ After the release branch has all commits required for the next patch release:
66
66
67
67
* Update `CHANGELOG.md` and `RELEASE_NOTES.md` (if applicable).
68
68
* Create a new annotated git tag (eg `git -a v1.1.0`) in the release branch.
69
-
* If the release is a submodule update, first go the submodule folder and name the tag prepending the path to the version:
69
+
* If the release is a submodule update, first go to the submodule folder and name the tag prepending the path to the version:
70
70
`cd core && git -a core/v1.1.0` or `cd tools/cosmovisor && git -a tools/cosmovisor/v1.4.0`
71
71
* Create a GitHub release (if applicable).
72
72
@@ -138,7 +138,7 @@ See the SDK's policy on migrations [here](https://docs.cosmos.network/main/migra
138
138
139
139
* State machine changes.
140
140
* Breaking changes in Protobuf definitions, as specified in [ADR-044](https://github.com/cosmos/cosmos-sdk/blob/main/docs/architecture/adr-044-protobuf-updates-guidelines.md).
141
-
* Changes that introduces API breakages (e.g. public functions and interfaces removal/renaming).
141
+
* Changes that introduce API breakages (e.g. public functions and interfaces removal/renaming).
142
142
* Client-breaking changes in gRPC and HTTP request and response types.
143
143
* CLI-breaking changes.
144
144
* Cosmetic fixes, such as formatting or linter warning fixes.
@@ -182,15 +182,15 @@ As rule of thumb, the following changes will **NOT** be automatically accepted i
182
182
```md
183
183
#### Impact
184
184
185
-
Brief xplanation of the effects of the bug on users and a justification for backporting the fix to the stable release.
185
+
Brief explanation of the effects of the bug on users and a justification for backporting the fix to the stable release.
186
186
187
187
#### Test Case
188
188
189
189
Detailed instructions on how to reproduce the bug on Stargate's most recently published point-release.
190
190
191
191
#### Regression Potential
192
192
193
-
Explanation on how regressions might manifest - even if it's unlikely.
193
+
Explanation of how regressions might manifest - even if it's unlikely.
194
194
It is assumed that stable release fixes are well-tested and they come with a low risk of regressions.
195
195
It's crucial to make the effort of thinking about what could happen in case a regression emerges.
* Sign mode textual has been under construction for 2 quarters now, this quarter the goal is to move towards v1 and potentially line up a audit before final release.
48
+
* Sign mode textual has been under construction for 2 quarters now, this quarter the goal is to move towards v1 and potentially line up an audit before final release.
49
49
*[x] Core API
50
50
*[Merge ADR for Core API](https://github.com/cosmos/cosmos-sdk/blob/main/docs/architecture/adr-063-core-module-api.md)
51
51
* Migrate three modules to use core api
@@ -66,7 +66,7 @@ Welcome to the Cosmos SDK's team roadmap.
* design and merge a integration testing framework.
69
+
* design and merge an integration testing framework.
70
70
* The goals of the framework would that a module only needs to depend on modules that it depends on outside of testing, not all modules in the sdk like today.
Copy file name to clipboardexpand all lines: UPGRADING.md
+4-4
Original file line number
Diff line number
Diff line change
@@ -476,7 +476,7 @@ Use `confix` to clean-up your `app.toml`. A nginx (or alike) reverse-proxy can b
476
476
477
477
#### Database Support
478
478
479
-
ClevelDB, BoltDB and BadgerDB are not supported anymore. To migrate from a unsupported database to a supported database please use a database migration tool.
479
+
ClevelDB, BoltDB and BadgerDB are not supported anymore. To migrate from an unsupported database to a supported database please use a database migration tool.
480
480
481
481
### Protobuf
482
482
@@ -1219,7 +1219,7 @@ mistakes.
1219
1219
1220
1220
#### `x/params`
1221
1221
1222
-
* The `x/params` module has been deprecated in favour of each module housing and providing way to modify their parameters. Each module that has parameters that are changeable during runtime have an authority, the authority can be a module or user account. The Cosmos SDK team recommends migrating modules away from using the param module. An example of how this could look like can be found [here](https://github.com/cosmos/cosmos-sdk/pull/12363).
1222
+
* The `x/params` module has been deprecated in favour of each module housing and providing way to modify their parameters. Each module that has parameters that are changeable during runtime has an authority, the authority can be a module or user account. The Cosmos SDK team recommends migrating modules away from using the param module. An example of how this could look like can be found [here](https://github.com/cosmos/cosmos-sdk/pull/12363).
1223
1223
* The Param module will be maintained until April 18, 2023. At this point the module will reach end of life and be removed from the Cosmos SDK.
1224
1224
1225
1225
#### `x/gov`
@@ -1232,11 +1232,11 @@ More information can be found in the gov module [client documentation](https://d
1232
1232
1233
1233
#### `x/staking`
1234
1234
1235
-
The `staking module` added a new message type to cancel unbonding delegations. Users that have unbonded by accident or wish to cancel a undelegation can now specify the amount and valdiator they would like to cancel the unbond from
1235
+
The `staking module` added a new message type to cancel unbonding delegations. Users that have unbonded by accident or wish to cancel an undelegation can now specify the amount and validator they would like to cancel the unbond from
1236
1236
1237
1237
### Protobuf
1238
1238
1239
-
The `third_party/proto` folder that existed in [previous version](https://github.com/cosmos/cosmos-sdk/tree/v0.45.3/third_party/proto) now does not contains directly the [proto files](https://github.com/cosmos/cosmos-sdk/tree/release/v0.46.x/third_party/proto).
1239
+
The `third_party/proto` folder that existed in [previous version](https://github.com/cosmos/cosmos-sdk/tree/v0.45.3/third_party/proto) now does not contain directly the [proto files](https://github.com/cosmos/cosmos-sdk/tree/release/v0.46.x/third_party/proto).
1240
1240
1241
1241
Instead, the SDK uses [`buf`](https://buf.build). Clients should have their own [`buf.yaml`](https://docs.buf.build/configuration/v1/buf-yaml) with `buf.build/cosmos/cosmos-sdk` as dependency, in order to avoid having to copy paste these files.
0 commit comments