Mark v1.20.0-rc3. #2193
Mark v1.20.0-rc3. #2193
Conversation
* Add a bit to the summary. * Mark v1.20.0-rc3
WalkthroughThis pull request involves the removal of the parameters store key and transient store key from the application, as documented in a deleted changelog entry. The Changes
Possibly related PRs
Suggested reviewers
Poem
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
CodeRabbit Configuration File (
|
![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 (1)
CHANGELOG.md (1)
Line range hint
1-228: Changelog structure and formatting review.The changelog is well-structured overall, but there are some areas for improvement:
Consistency: Ensure consistent formatting across all entries. For example, some entries use full sentences with periods, while others don't.
Links: While many entries include links to issues or PRs, some don't. Consider adding links to all relevant issues/PRs for better traceability.
Versioning: The versioning scheme is clear, with release candidates (RC) properly labeled.
Categorization: The use of categories (Features, Improvements, Bug Fixes, etc.) is helpful for quick reference.
Markdown usage: The markdown formatting is generally good, but ensure all lists are properly indented for better readability.
Consider running a markdown linter to catch any formatting inconsistencies. For example:
#!/bin/bash # Run markdownlint on the CHANGELOG.md file npx markdownlint-cli CHANGELOG.mdThis will help maintain a consistent and readable changelog.
🧰 Tools
🪛 Markdownlint
64-64: null
Bare URL used(MD034, no-bare-urls)
65-65: null
Bare URL used(MD034, no-bare-urls)
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
📒 Files selected for processing (2)
- .changelog/unreleased/bug-fixes/2189-remove-params-storekey.md (0 hunks)
- CHANGELOG.md (1 hunks)
💤 Files with no reviewable changes (1)
- .changelog/unreleased/bug-fixes/2189-remove-params-storekey.md
🧰 Additional context used
🪛 Markdownlint
CHANGELOG.md
64-64: null
Bare URL used(MD034, no-bare-urls)
65-65: null
Bare URL used(MD034, no-bare-urls)
🔇 Additional comments (4)
CHANGELOG.md (4)
55-65: New release v1.20.0-rc3 with bug fix and commit history.The changelog entry for v1.20.0-rc3 includes:
- A bug fix addressing an issue from v1.20.0-rc2.
- Links to the full commit history.
Some observations:
- The bug fix removes the params store key and transient store key from the app, resolving a problem that prevented nodes from restarting if stopped after the upgrade.
- The full commit history is provided via GitHub comparison links, which is helpful for developers who want to see all changes in detail.
🧰 Tools
🪛 Markdownlint
64-64: null
Bare URL used(MD034, no-bare-urls)
65-65: null
Bare URL used(MD034, no-bare-urls)
Line range hint
67-80: v1.20.0-rc2 release with bug fixes and commit history.The changelog entry for v1.20.0-rc2 includes:
- Two bug fixes:
- Renaming the RELEASE_NOTES.md file to RELEASE_CHANGELOG.md
- Fixing the heighliner build
- Links to the full commit history
Observations:
- The bug fixes seem minor but could be important for maintaining consistency in documentation and build processes.
- The full commit history is again provided via GitHub comparison links, maintaining transparency and traceability.
🧰 Tools
🪛 Markdownlint
64-64: null
Bare URL used(MD034, no-bare-urls)
65-65: null
Bare URL used(MD034, no-bare-urls)
Line range hint
1-228: Overall assessment of the CHANGELOG.md file.The CHANGELOG.md file is a valuable resource for users and developers of the Provenance blockchain. It provides a comprehensive history of changes, improvements, and bug fixes across multiple versions.
Strengths:
- Chronological order with the most recent changes at the top.
- Clear versioning, including release candidates.
- Categorization of changes (Features, Improvements, Bug Fixes, etc.).
- Links to GitHub issues and pull requests for many entries.
- Inclusion of both major and minor changes.
Areas for potential improvement:
- Consistency in formatting and level of detail across entries.
- Ensuring all entries have links to relevant issues or pull requests.
- More consistent use of markdown formatting for better readability.
Despite these minor areas for improvement, the changelog effectively communicates the project's evolution and helps users understand what to expect in each new version.
To maintain and improve the quality of the changelog, consider implementing a changelog entry checklist for contributors, ensuring that each new entry follows a consistent format and includes all necessary information.
🧰 Tools
🪛 Markdownlint
64-64: null
Bare URL used(MD034, no-bare-urls)
65-65: null
Bare URL used(MD034, no-bare-urls)
Line range hint
82-228: Comprehensive v1.20.0-rc1 release with significant changes and updates.This release includes numerous changes across various categories:
Features:
- Creation of the 'viridian' upgrade
- Changes to NAV (Net Asset Value) handling
- Addition of the circuit breaker module
Improvements:
- Multiple module parameter migrations
- Removal of legacy proposals and unused code
- Updates to various dependencies
Bug Fixes:
- Several fixes related to proto generation, CLI commands, and module behaviors
Client Breaking Changes:
- Removal of old provwasm bindings
- Changes to some proto enum values
API Breaking Changes:
- Changes to query behaviors in the metadata module
- Removal of the params module
Dependencies:
- Numerous updates to various dependencies, including Cosmos SDK, CosmWasm, and others
Key points to note:
- The removal of legacy code and migration of parameters could improve overall system efficiency.
- The addition of the circuit breaker module may enhance system safety.
- API and client breaking changes should be clearly communicated to users to ensure smooth transitions.
- The extensive dependency updates suggest improved security and performance, but thorough testing is crucial.
To ensure all breaking changes are properly documented and communicated:
🧰 Tools
🪛 Markdownlint
64-64: null
Bare URL used(MD034, no-bare-urls)
65-65: null
Bare URL used(MD034, no-bare-urls)
Description
This PR marks
v1.20.0-rc3inmain.It's basically a frontport of this PR:
Before we can merge this PR, please make sure that all the following items have been
checked off. If any of the checklist items are not applicable, please leave them but
write a little note why.
docs/) or specification (x/<module>/spec/).godoccomments..changelog/unreleased(see Adding Changes).Files changedin the Github PR explorer.Codecov Reportin the comment section below once CI passes.Summary by CodeRabbit
Bug Fixes
Documentation
v1.20.0-rc3, including links to previous versions and a full commit history.