docs: re-arrange and clarify migration docs (#15575)
This commit is contained in:
parent
d8a6dcc647
commit
22621995b5
@ -120,7 +120,7 @@ ways in stable releases and `main` branch.
|
||||
|
||||
### Migrations
|
||||
|
||||
To smoothen the update to the latest stable release, the SDK includes a set of CLI commands for managing migrations between SDK versions, under the `migrate` subcommand. Only migration scripts between stable releases are included. For the current major release, and later, migrations are supported.
|
||||
See the SDK's policy on migrations [here](https://docs.cosmos.network/main/migrations/intro).
|
||||
|
||||
### What qualifies as a Stable Release Update (SRU)
|
||||
|
||||
|
||||
10
UPGRADING.md
10
UPGRADING.md
@ -66,16 +66,16 @@ This is no longer the case, the assertion has been loosened to only require modu
|
||||
|
||||
The following modules `NewKeeper` function now take a `KVStoreService` instead of a `StoreKey`:
|
||||
|
||||
- `x/auth`
|
||||
- `x/consensus`
|
||||
* `x/auth`
|
||||
* `x/consensus`
|
||||
|
||||
When not using depinject, the `runtime.NewKVStoreService` method can be used to create a `KVStoreService` from a `StoreKey`:
|
||||
|
||||
```diff
|
||||
- app.ConsensusParamsKeeper = consensusparamkeeper.NewKeeper(appCodec, keys[consensusparamtypes.StoreKey], authtypes.NewModuleAddress(govtypes.ModuleName).String())
|
||||
+ app.ConsensusParamsKeeper = consensusparamkeeper.NewKeeper(
|
||||
app.ConsensusParamsKeeper = consensusparamkeeper.NewKeeper(
|
||||
appCodec,
|
||||
runtime.NewKVStoreService(keys[consensusparamtypes.StoreKey]),
|
||||
- keys[consensusparamtypes.StoreKey]
|
||||
+ runtime.NewKVStoreService(keys[consensusparamtypes.StoreKey]),
|
||||
authtypes.NewModuleAddress(govtypes.ModuleName).String(),
|
||||
)
|
||||
```
|
||||
|
||||
1
docs/.gitignore
vendored
1
docs/.gitignore
vendored
@ -19,6 +19,7 @@ docs/docs/tooling/02-depinject.md
|
||||
docs/docs/tooling/03-confix.md
|
||||
docs/docs/tooling/04-hubl.md
|
||||
docs/run-node/04-rosetta.md
|
||||
docs/migrations/02-upgrading.md
|
||||
|
||||
# Misc
|
||||
.DS_Store
|
||||
|
||||
@ -2,7 +2,17 @@
|
||||
sidebar_position: 1
|
||||
---
|
||||
|
||||
# Pre-Upgrade Handling
|
||||
# Application upgrade
|
||||
|
||||
:::note
|
||||
This document describes how to upgrade your application. If you are looking specifically for the changes to perform between SDK versions, see the [SDK migrations documentation](https://docs.cosmos.network/main/migrations/intro).
|
||||
:::
|
||||
|
||||
:::warning
|
||||
This section is currently incomplete. Track the progress of this document [here](https://github.com/cosmos/cosmos-sdk/issues/11504).
|
||||
:::
|
||||
|
||||
## Pre-Upgrade Handling
|
||||
|
||||
Cosmovisor supports custom pre-upgrade handling. Use pre-upgrade handling when you need to implement application config changes that are required in the newer version before you perform the upgrade.
|
||||
|
||||
@ -1,11 +0,0 @@
|
||||
---
|
||||
sidebar_position: 1
|
||||
---
|
||||
|
||||
# Introduction to Migrations
|
||||
|
||||
This document contains all the migration guides to update your app and modules to the current Cosmos SDK.
|
||||
|
||||
1. Chain Upgrade Guide to v0.47:
|
||||
* See [UPGRADING.md](https://github.com/cosmos/cosmos-sdk/blob/v0.47.0-rc1/UPGRADING.md) for breaking changes and deprecations upgrade instructions.
|
||||
* See [Release Notes](https://github.com/cosmos/cosmos-sdk/blob/v0.47.0-rc1/RELEASE_NOTES.md) and [changelog](https://github.com/cosmos/cosmos-sdk/blob/v0.47.0-rc1/CHANGELOG.md) for the exhaustive list of API and State Machine breaking changes.
|
||||
15
docs/docs/migrations/01-intro.md
Normal file
15
docs/docs/migrations/01-intro.md
Normal file
@ -0,0 +1,15 @@
|
||||
---
|
||||
sidebar_position: 1
|
||||
---
|
||||
|
||||
# SDK Migrations
|
||||
|
||||
To smoothen the update to the latest stable release, the SDK includes a CLI command for hard-fork migrations (under the `<appd> genesis migrate` subcommand).
|
||||
Additionally, the SDK includes in-place migrations for its core modules. These in-place migrations are useful to migrate between major releases.
|
||||
|
||||
* Hard-fork migrations are supported from the last major release to the current one.
|
||||
* In-place module migrations are supported from the last two major releases to the current one.
|
||||
|
||||
Migration from a version older than the last two major releases is not supported.
|
||||
|
||||
When migrating from a previous version, refer to the [`UPGRADING.md`](./02-upgrading.md) and the `CHANGELOG.md` of the version you are migrating to.
|
||||
@ -1,5 +1,5 @@
|
||||
{
|
||||
"label": "Migrations",
|
||||
"label": "SDK Migrations",
|
||||
"position": 6,
|
||||
"link": null
|
||||
}
|
||||
@ -389,6 +389,10 @@ const config = {
|
||||
from: ["/main/run-node/cosmovisor"],
|
||||
to: "/main/tooling/cosmovisor",
|
||||
},
|
||||
{
|
||||
from: ["/main/migrations/pre-upgrade"],
|
||||
to: "/main/building-apps/migrations",
|
||||
},
|
||||
],
|
||||
},
|
||||
],
|
||||
|
||||
@ -9,4 +9,5 @@ rm -rf docs/run-node/04-rosetta.md
|
||||
rm -rf docs/architecture
|
||||
rm -rf docs/spec
|
||||
rm -rf docs/rfc
|
||||
rm -rf docs/migrations/02-upgrading.md
|
||||
rm -rf versioned_docs versioned_sidebars versions.json
|
||||
@ -33,4 +33,7 @@ cp -r ./architecture ./docs
|
||||
cp -r ./spec ./docs
|
||||
|
||||
## Add rfc documentation
|
||||
cp -r ./rfc ./docs
|
||||
cp -r ./rfc ./docs
|
||||
|
||||
## Add SDK migration documentation
|
||||
cp -r ../UPGRADING.md ./docs/migrations/02-upgrading.md
|
||||
Loading…
Reference in New Issue
Block a user