Skip to content

Commit

Permalink
chore: readmes + upgrading docs (prepare alpha) (backport #21271) (#2…
Browse files Browse the repository at this point in the history 
…1318)

Co-authored-by: Julien Robert <julien@rbrt.fr>
  • Loading branch information
@mergify @julienrbrt
mergify[bot] and julienrbrt authored Aug 15, 2024
1 parent 60dc259 commit 6833172
Show file tree
Hide file tree
Showing 60 changed files with 885 additions and 4,397 deletions.
2,954 changes: 84 additions & 2,870 deletions CHANGELOG.md
View file

Large diffs are not rendered by default.

59 changes: 30 additions & 29 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -66,41 +66,42 @@ The version matrix below shows which versions of the Cosmos SDK, modules and lib

#### Core Dependencies

Core Dependencies are the core libraries that an application may depend on.
Core dependencies are the core libraries that an application may depend on.
Core dependencies not mentionned here as compatible across all maintained SDK versions.

> Note: the ❌ signals that the version of the Cosmos SDK does not need to import the dependency.
| Cosmos SDK | cosmossdk.io/core | cosmossdk.io/api | cosmossdk.io/math | cosmossdk.io/errors | cosmossdk.io/depinject | cosmossdk.io/log | cosmossdk.io/store |
| ---------- | ----------------- | ---------------- | ----------------- | ------------------- | ---------------------- | ---------------- | ------------------ |
| 0.50.z | 0.11.z | 0.7.z | 1.y.z | 1.y.z | 1.y.z | 1.y.z | 1.y.z |
| 0.47.z | 0.5.z | 0.3.z | 1.y.z | 1.y.z | 1.y.z | 1.y.z | ❌ |
| 0.46.z | ❌ | ❌ | 1.y.z | 1.y.z | ❌ | ❌ | ❌ |
| Cosmos SDK | cosmossdk.io/core | cosmossdk.io/api | cosmossdk.io/x/tx |
| ---------- | ----------------- | ---------------- | ----------------- |
| 0.52.z | 1.y.z | 0.8.z | 0.14.z |
| 0.50.z | 0.11.z | 0.7.z | 0.13.z |
| 0.47.z | 0.5.z | 0.3.z | N/A |

#### Module Dependencies

Module Dependencies are the modules that an application may depend on and which version of the Cosmos SDK they are compatible with.

> 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.
| Cosmos SDK | 0.50.z | 0.y.z |
| --------------------------- | --------- | ----- |
| cosmossdk.io/x/auth | ❌ | |
| cosmossdk.io/x/accounts | ❌ | |
| cosmossdk.io/x/bank | ❌ | |
| cosmossdk.io/x/circuit | 0.1.z | |
| cosmossdk.io/x/consensus | ❌ | |
| cosmossdk.io/x/distribution | ❌ | |
| cosmossdk.io/x/evidence | 0.1.z | |
| cosmossdk.io/x/feegrant | 0.1.z | |
| cosmossdk.io/x/gov | ❌ | |
| cosmossdk.io/x/group | ❌ | |
| cosmossdk.io/x/mint | ❌ | |
| cosmossdk.io/x/nft | 0.1.z | |
| cosmossdk.io/x/protcolpool | ❌ | |
| cosmossdk.io/x/slashing | ❌ | |
| cosmossdk.io/x/staking | ❌ | |
| cosmossdk.io/x/tx | =< 0.13.z | |
| cosmossdk.io/x/upgrade | 0.1.z | |
> Note: The version table only goes back to 0.50.x, as modules started to become modular with 0.50.z.
> X signals that the module was not spun out into its own go.mod file.
> N/A signals that the module was not available in the Cosmos SDK at that time.
| Cosmos SDK | 0.50.z | 0.52.z |
| --------------------------- | ------ | ------ |
| cosmossdk.io/x/auth | X | 0.2.z |
| cosmossdk.io/x/accounts | N/A | 0.2.z |
| cosmossdk.io/x/bank | X | 0.2.z |
| cosmossdk.io/x/circuit | 0.1.z | 0.2.z |
| cosmossdk.io/x/consensus | X | 0.2.z |
| cosmossdk.io/x/distribution | X | 0.2.z |
| cosmossdk.io/x/epochs | N/A | 0.2.z |
| cosmossdk.io/x/evidence | 0.1.z | 0.2.z |
| cosmossdk.io/x/feegrant | 0.1.z | 0.2.z |
| cosmossdk.io/x/gov | X | 0.2.z |
| cosmossdk.io/x/group | X | 0.2.z |
| cosmossdk.io/x/mint | X | 0.2.z |
| cosmossdk.io/x/nft | 0.1.z | 0.2.z |
| cosmossdk.io/x/protocolpool | N/A | 0.2.z |
| cosmossdk.io/x/slashing | X | 0.2.z |
| cosmossdk.io/x/staking | X | 0.2.z |
| cosmossdk.io/x/upgrade | 0.1.z | 0.2.z |

## Disambiguation

Expand Down
13 changes: 13 additions & 0 deletions RELEASE_NOTES.md
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
# Cosmos SDK v0.52.0-alpha.1 Release Notes

There are no release notes for pre-releases.

A beta release will be cut in the coming days after [audits](https://github.com/cosmos/cosmos-sdk/issues/21176).
Cosmos SDK modules won't be tagged before RC, when integrating with alphas and betas, use the latest pseudo version from the release branch for SDK modules or main for other packages. Refer to the [version matrix](https://github.com/cosmos/cosmos-sdk?tab=readme-ov-file#version-matrix) to understand what it means.
On the other hand, `cosmossdk.io/core` v1 beta will be cut [soon](https://github.com/cosmos/cosmos-sdk/issues/21176), to allow you to upgrade your modules easily.
Lastly, this alpha contains some dependencies annoyance that will be resolved before the RC (i.e. the SDK is temporarily importing `auth`, `bank` and `staking`).

Please see the [CHANGELOG](https://github.com/cosmos/cosmos-sdk/blob/release/v0.52.x/CHANGELOG.md) for an exhaustive list of changes.
Refer to the [UPGRADING.md](https://github.com/cosmos/cosmos-sdk/blob/release/v0.52.x/UPGRADING.md) for upgrading your application.

Full Commit History: https://github.com/cosmos/cosmos-sdk/compare/release/v0.50.x...release/v0.52.x
Loading

0 comments on commit 6833172

Please sign in to comment.