docs(simapp): update CHANGELOG to proper version #22739
Conversation
aljo242
requested review from
facundomedica,
julienrbrt and
a team
as code owners
📝 WalkthroughWalkthroughThe pull request updates the changelog for the Changes
Possibly related PRs
Suggested labels
Suggested reviewers
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? 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
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)
Other keywords and placeholders
Documentation and Community
|
julienrbrt
changed the title
julienrbrt
added
the
backport/v0.52.x
julienrbrt
changed the title
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Outside diff range and nitpick comments (3)
simapp/CHANGELOG.md (3)
Line range hint
31-45: Reorganize changelog entries according to the guidelinesThe changelog entries should follow the format specified in the guiding principles:
- Group changes by type (Features, Improvements, API Breaking, etc.)
- Include tags and GitHub issue references for all entries
Example structure:
### Features * (modules) [#XXXXX] Wire new SDK modules (`epochs`, `accounts`, `protocolpool`). * (mint) [#XXXXX] Add example of how to define a custom mint function. ### Improvements * (client) [#XXXXX] Add address codec in client context and signing context. * (testutil) [#20490] Refactor simulations to use `testutil/sims`. ### API Breaking * (upgrade) [#20485] Change signature of `UpgradeHandler` to accept `appmodule.VersionMap`.
Line range hint
46-46: Clarify the TODO commentThe comment "" lacks context. Please specify:
- Which changelog elements need to be moved
- The source location of these elements
- The rationale for moving them
Would you like me to help track this TODO by creating a GitHub issue?
Line range hint
48-54: Consider adding brief summaries for previous versionsWhile linking to UPGRADING.md is helpful, consider adding brief summaries of key changes for each version. This aligns with the principle "Changelogs are for humans" and helps readers quickly understand the major changes without leaving the changelog.
📜 Review details
Configuration used: .coderabbit.yml
Review profile: CHILL
📒 Files selected for processing (1)
simapp/CHANGELOG.md(1 hunks)
🧰 Additional context used
📓 Path-based instructions (1)
simapp/CHANGELOG.md (1)
Pattern **/*.md: "Assess the documentation for misspellings, grammatical errors, missing documentation and correctness"
🔇 Additional comments (1)
simapp/CHANGELOG.md (1)
Line range hint 1-54: Verify all document links are valid
Let's ensure all links in the changelog are accessible.
✅ Verification successful
All links in the changelog are valid and accessible
All GitHub PR links and the UPGRADING.md reference in the changelog have been verified:
- All 8 PR links (20409, 20485, 20740, 20771, 20490, 19726, 21466, 21508) are accessible
- The UPGRADING.md file exists in the repository root
🏁 Scripts executed
The following scripts were executed for the analysis:
Script:
#!/bin/bash
# Description: Verify that all links in the changelog are valid
# Extract and verify GitHub PR links
echo "Checking PR links..."
prLinks=$(rg -o 'https://github.com/cosmos/cosmos-sdk/pull/[0-9]+' simapp/CHANGELOG.md)
for link in $prLinks; do
gh api "repos/cosmos/cosmos-sdk/pulls/${link##*/}" --jq '.url' || echo "Invalid PR link: $link"
done
# Verify UPGRADING.md exists
echo "Checking UPGRADING.md reference..."
test -f UPGRADING.md && echo "UPGRADING.md exists" || echo "UPGRADING.md not found"
Length of output: 1773
(cherry picked from commit 99dd55b)
…22740) Co-authored-by: Alex | Skip <[email protected]>
Description
Closes: #XXXX
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...
!in the type prefix if API or client breaking changeCHANGELOG.mdReviewers 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...
Summary by CodeRabbit
New Features
epochs,accounts, andprotocolpool.Improvements
exportfunction with the new module collections API.Bug Fixes
UpgradeHandlerto improve compatibility.