chore: package release prep + update UPGRADING.md

[julienrbrt]

Description

Prepares store v1 x v0.52 rc, collections v1 rc, schema v1 and core/testing 0.0.1

Check the changes between last store (store v1):
git difftool store/v1.1.1..main -- store ':(exclude)store/v2

While store is tagged v1, due to its CometBFT and core dependencies, the latest version works effectively only with 0.52+ (or any Cosmos SDK version using CometBFT v1 and core v1).

---

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...

• included the correct type prefix in the PR title, you can find examples of the prefixes below:
• confirmed ! in the type prefix if API or client breaking change
• targeted the correct branch (see PR Targeting)
• provided a link to the relevant issue or specification
• reviewed "Files changed" and left comments if necessary
• included the necessary unit and integration tests
• added a changelog entry to CHANGELOG.md
• updated the relevant documentation or specification, including comments for documenting Go code
• confirmed all CI checks have passed

Reviewers 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.

Please see Pull Request Reviewer section in the contributing guide for more information on how to review a pull request.

I have...

• confirmed the correct type prefix in the PR title
• confirmed all author checklist items have been addressed
• reviewed state machine logic, API design and naming, documentation is accurate, tests and test coverage

Summary by CodeRabbit

Summary by CodeRabbit

• New Features

  • Added compatibility information for Cosmos SDK v2 in the documentation.
  • Introduced new collection types and features in the collections module, including Vec, Triple, and Quad.
  • Added LatestVersion method to the Committer interface in the store module.
  • Introduced the cosmossdk.io/schema module.
  • Enhanced documentation on module structure and roles within the Cosmos SDK.

• Bug Fixes

  • Resolved nil pointer panic and unexhausted payload stream errors in the store module.

• Documentation

  • Updated version matrix and module dependencies in the README.
  • Enhanced clarity and organization in various changelogs.
  • Clarified release procedures in the RELEASE_PROCESS.md.
  • Updated UPGRADING.md with migration guidance for version v0.52.x.

[coderabbitai]

📝 Walkthrough

📝 Walkthrough

Walkthrough

The pull request includes significant updates to multiple documentation files and changelogs. The README.md now features a new section on Cosmos SDK v2 compatibility, updated version matrix tables, and modified module dependencies. The collections module changelog introduces a new version v1.0.0 with several new features and improvements. The core/testing changelog adds an initial version entry, while the store changelog includes new version entries and a disclaimer about versioning. Overall, these changes enhance clarity and organization across the documentation and changelogs.

Changes

File	Change Summary
README.md	Added compatibility section for Cosmos SDK v2, updated version matrix and module dependencies tables.
collections/CHANGELOG.md	Added new version entry v1.0.0 with features like Vec, Triple, Quad, LookupMap, and NewJSONValueCodec.
core/testing/CHANGELOG.md	Added initial version entry v0.0.1.
store/CHANGELOG.md	Added disclaimer about versioning, new entries for v1.10.0 and v1.1.1, and improvements to the changelog structure.
RELEASE_PROCESS.md	Updated release procedures, including notes on skipped versions and module management.
UPGRADING.md	Significant updates on nested message simulation, gas calculations, and module refactoring.
docs/build/building-modules/00-intro.md	Enhanced clarity on module roles and structure within the Cosmos SDK.

Possibly related issues

• v0.52 Documentation #21429: The changes in documentation for version v2 compatibility directly address the need for updates in the cosmos/cosmos-sdk-docs repository as outlined in this issue.

Suggested reviewers

• tac0turtle

Tip

CodeRabbit's docstrings feature is now available as part of our Early Access Program! Simply use the command @coderabbitai generate docstrings to have CodeRabbit automatically generate docstrings for your pull request. This feature will be included in our Pro Plan when released.

---

📜 Recent review details

Configuration used: .coderabbit.yml
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 2cd1e58 and b5cfcd7.

📒 Files selected for processing (2)

• x/group/go.mod (0 hunks)
• x/group/testutil/app_config.go (0 hunks)

💤 Files with no reviewable changes (2)

• x/group/testutil/app_config.go
• x/group/go.mod

---

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>, please review it.
  • Generate unit testing code for this file.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai generate unit testing code for this file.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @coderabbitai read src/utils.ts and generate unit testing code.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai generate docstrings to generate docstrings for this PR. (Beta)
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.

[julienrbrt]

Adding two backport labels. In v52 the readme will be backported.
In v0.50 the disclaimer of store v1 will be backported.

[coderabbitai]

Actionable comments posted: 0

🧹 Outside diff range and nitpick comments (2)

store/CHANGELOG.md (1)

26-31: Improve formatting and clarity of the versioning disclaimer

The disclaimer contains crucial versioning information but could be better formatted for readability.

Consider this improved formatting:

-> **Disclaimer**: Numbers from v1.0.x to v1.9.x are reserved for the v0.50 line.
-> cosmossdk.io/store compatible with the v0.50 line is tagged from release/v0.50.x
-> Numbers from v1.10.x onwards are reserved for the 0.52+ line.
-> With Cosmos SDK v2 (with store/v2), CometBFT has been pushed to the boundaries, so issues like this
-> are not expected to happen again.
+> **Version Compatibility:**
+> * v1.0.x - v1.9.x: Reserved for Cosmos SDK v0.50 line
+>   * Compatible versions are tagged from release/v0.50.x
+> * v1.10.x onwards: Reserved for Cosmos SDK v0.52+ line
+> * For Cosmos SDK v2: Uses store/v2 with CometBFT at boundaries
+>   * Previous versioning issues are not applicable

README.md (1)

70-72: Improve sentence variety in the core dependencies section

The consecutive sentences beginning with "Core dependencies" create a repetitive structure.

Consider this revision:

-Core dependencies are the core libraries that an application may depend on.
-Core dependencies not mentioned here as compatible across all maintained SDK versions.
-See an exhaustive list of core dependencies at [cosmossdk.io](https://cosmossdk.io).
+Core dependencies are the essential libraries that applications may rely on.
+Any dependencies not listed here are compatible across all maintained SDK versions.
+For an exhaustive list of core dependencies, visit [cosmossdk.io](https://cosmossdk.io).

🧰 Tools

🪛 LanguageTool

[style] ~70-~70: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...ries that an application may depend on. Core dependencies not mentioned here as comp...

(ENGLISH_WORD_REPEAT_BEGINNING_RULE)

📜 Review details

Configuration used: .coderabbit.yml
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 957e241 and 4dc5aeb.

📒 Files selected for processing (4)

• README.md (2 hunks)
• collections/CHANGELOG.md (1 hunks)
• core/testing/CHANGELOG.md (1 hunks)
• store/CHANGELOG.md (1 hunks)

✅ Files skipped from review due to trivial changes (1)

• core/testing/CHANGELOG.md

🧰 Additional context used

📓 Path-based instructions (3)

README.md (1)

Pattern **/*.md: "Assess the documentation for misspellings, grammatical errors, missing documentation and correctness"

store/CHANGELOG.md (1)

Pattern **/*.md: "Assess the documentation for misspellings, grammatical errors, missing documentation and correctness"

collections/CHANGELOG.md (1)

Pattern **/*.md: "Assess the documentation for misspellings, grammatical errors, missing documentation and correctness"

🪛 LanguageTool

README.md

[style] ~70-~70: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...ries that an application may depend on. Core dependencies not mentioned here as comp...

(ENGLISH_WORD_REPEAT_BEGINNING_RULE)

🔇 Additional comments (3)

collections/CHANGELOG.md (1)

34-35: Well-structured changelog entry for v1.0.0

The changelog entry follows the standard format, includes proper linking to the release tag, and provides clear categorization of changes.

store/CHANGELOG.md (1)

34-45: Well-structured changelog entries

The version entries are properly formatted with clear categorization of improvements and bug fixes, including PR references.

README.md (1)

74-81: Well-structured version matrix

The version matrix clearly presents compatibility information across different versions.

[coderabbitai]

Actionable comments posted: 0

🧹 Outside diff range and nitpick comments (3)

RELEASE_PROCESS.md (3)

251-251: Fix grammatical error in exceptions statement

The sentence has incorrect subject-verb agreement and number agreement.

-There is two exception to this rule, due to the stabilization of core v1: `cosmossdk.io/x/tx` and `cosmossdk.io/store` are still tagged from the `release/v0.50.x` branch for `v0.50.x` releases.
+There are two exceptions to this rule, due to the stabilization of core v1: `cosmossdk.io/x/tx` and `cosmossdk.io/store` are still tagged from the `release/v0.50.x` branch for `v0.50.x` releases.

🧰 Tools

🪛 LanguageTool

[grammar] ~251-~251: After the number ‘two’, use a plural noun. Did you mean “exceptions”?
Context: ...rom the release branch**. There is two exception to this rule, due to the stabilization ...

(CD_NNU)

---

249-250: Enhance clarity of module removal requirement

While the statement is clear, it would be helpful to add a note about the practical implications for developers who need to reference these modules in their release branches.

All modules that do not depend on the Cosmos SDK and tagged from main in a release branch **must be removed from the release branch**.

+Note: Developers working with release branches should reference these modules using their latest released versions from the main branch instead.

---

248-251: Consider adding a visual representation of the branching strategy

The branching strategy section would benefit from a diagram illustrating the relationship between main branch, release branches, and module tagging process. This would help readers better understand the flow and dependencies.

Would you like me to help create a mermaid diagram to visualize this branching strategy?

🧰 Tools

🪛 LanguageTool

[grammar] ~251-~251: After the number ‘two’, use a plural noun. Did you mean “exceptions”?
Context: ...rom the release branch**. There is two exception to this rule, due to the stabilization ...

(CD_NNU)

📜 Review details

Configuration used: .coderabbit.yml
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 4dc5aeb and a1802bd.

📒 Files selected for processing (1)

• RELEASE_PROCESS.md (1 hunks)

🧰 Additional context used

📓 Path-based instructions (1)

RELEASE_PROCESS.md (1)

Pattern **/*.md: "Assess the documentation for misspellings, grammatical errors, missing documentation and correctness"

🪛 LanguageTool

RELEASE_PROCESS.md

[grammar] ~251-~251: After the number ‘two’, use a plural noun. Did you mean “exceptions”?
Context: ...rom the release branch**. There is two exception to this rule, due to the stabilization ...

(CD_NNU)

[coderabbitai]

Actionable comments posted: 0

🧹 Outside diff range and nitpick comments (5)

docs/build/building-modules/00-intro.md (1)

66-67: Consider adding more context about core APIs.

The statement about using core APIs is important but could benefit from more context. Consider adding:

1. Examples of common core APIs
2. Benefits of using core APIs over direct SDK imports
3. Link to core API documentation

RELEASE_PROCESS.md (2)

239-242: Consider rephrasing the warning about module versioning.

The warning about module versioning could be clearer. Consider rephrasing to:
"Modules depending on unstable versions of github.com/cosmos/cosmos-sdk (prior to the removal of baseapp, runtime, server) MUST NOT use semantic versioning. Instead, these modules should use 0-based versioning until the main SDK has stabilized."

🧰 Tools

🪛 LanguageTool

[style] ~240-~240: ‘prior to’ might be wordy. Consider a shorter alternative.
Context: ...hub.com/cosmos/cosmos-sdk` (any version prior to the removal of baseapp, runtime, server...

(EN_WORDINESS_PREMIUM_PRIOR_TO)

---

253-254: Consider adding rationale for module removal.

The statement about module removal would benefit from explaining why modules are removed from release branches. Consider adding a brief explanation of the technical reasons.

UPGRADING.md (2)

501-504: Add more context to the mint module changes.

The mint module section would benefit from:

1. Brief explanation of what a mint function is
2. Example of a custom mint function implementation
3. Impact of these changes on existing implementations

---

545-548: Enhance benchmark tool documentation.

The benchmark tool section should include:

1. Warning about production usage implications
2. Link to detailed documentation
3. Example usage scenarios

📜 Review details

Configuration used: .coderabbit.yml
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between a1802bd and 5a1ef87.

📒 Files selected for processing (3)

• RELEASE_PROCESS.md (2 hunks)
• UPGRADING.md (2 hunks)
• docs/build/building-modules/00-intro.md (1 hunks)

🧰 Additional context used

📓 Path-based instructions (3)

docs/build/building-modules/00-intro.md (1)

Pattern **/*.md: "Assess the documentation for misspellings, grammatical errors, missing documentation and correctness"

UPGRADING.md (1)

Pattern **/*.md: "Assess the documentation for misspellings, grammatical errors, missing documentation and correctness"

RELEASE_PROCESS.md (1)

Pattern **/*.md: "Assess the documentation for misspellings, grammatical errors, missing documentation and correctness"

🪛 LanguageTool

RELEASE_PROCESS.md

[style] ~240-~240: ‘prior to’ might be wordy. Consider a shorter alternative.
Context: ...hub.com/cosmos/cosmos-sdk` (any version prior to the removal of baseapp, runtime, server...

(EN_WORDINESS_PREMIUM_PRIOR_TO)

[julienrbrt]

Fails on the same thing: #22873 (review)

[julienrbrt]

• https://github.com/cosmos/cosmos-sdk/releases/tag/store%2Fv1.10.0-rc.1
• https://github.com/cosmos/cosmos-sdk/releases/tag/schema%2Fv1.0.0
• https://github.com/cosmos/cosmos-sdk/releases/tag/core%2Ftesting%2Fv0.0.1
• https://github.com/cosmos/cosmos-sdk/releases/tag/collections%2Fv1.0.0-rc.1 (Final after @testinginprod latest changes)