docs: update upgrade doc and changelog for MigrationModuleManager #17373
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
alexanderbez
approved these changes
Aug 12, 2023
julienrbrt
reviewed
Aug 12, 2023
| @@ -74,6 +74,11 @@ allows an application to define handlers for these methods via `ExtendVoteHandle | |||
| and `VerifyVoteExtensionHandler` respectively. Please see [here](https://docs.cosmos.network/v0.50/building-apps/vote-extensions) | |||
| for more info. | |||
|
|
|||
| ```diff | |||
There was a problem hiding this comment.
We should add the following to be more precise:
**Users using `depinject` / app v2 do not need any changes, this is abstracted for them.**I would as well create this within an Upgrade section under baseapp (like done for Events).
julienrbrt
added
the
backport/v0.50.x
|
can we get updates to the upgrade section in docs. (https://docs.cosmos.network/main/building-apps/app-upgrade) and potentially others, this is pretty breaking for users |
julienrbrt
reviewed
Aug 13, 2023
| @@ -52,6 +52,12 @@ be a matter of minutes and not even require them to be awake at that time. | |||
|
|
|||
| ## Integrating With An App | |||
|
|
|||
| After app initiation, call `SetMigrationModuleManager` with ModuleManager to give BaseApp access to `RunMigrationBeginBlock`: | |||
There was a problem hiding this comment.
We need to add a :::tip (https://docusaurus.io/docs/next/markdown-features/admonitions) that says the same thing about not being necessary for users of app v2 / depinject.
Or alternatively this should be in a :::warning saying this is required when not using app v2.
julienrbrt
approved these changes
Aug 13, 2023
julienrbrt
pushed a commit
that referenced
this pull request
Aug 13, 2023
mmsqe
added a commit
to mmsqe/cosmos-sdk
that referenced
this pull request
Aug 16, 2023
…smos#17373) Co-authored-by: Julien Robert <julien@rbrt.fr>
mmsqe
added a commit
to crypto-org-chain/cosmos-sdk
that referenced
this pull request
Sep 5, 2023
…smos#17373) Co-authored-by: Julien Robert <julien@rbrt.fr>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
For more info
Author Checklist
All items are required. Please add a note to the item if the item is not applicable and
please add links to any relevant follow up issues.
I have...
!to the type prefix if API or client breaking changeCHANGELOG.mdmake lintandmake testReviewers Checklist
All items are required. Please add a note if the item is not applicable and please add
your handle next to the items reviewed if you only reviewed selected items.
I have...
!in the type prefix if API or client breaking change