-
Notifications
You must be signed in to change notification settings - Fork 595
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
chore: tagged v27 changelog #8822
Conversation
WalkthroughThe pull request introduces a new version entry 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
CodeRabbit Configuration File (
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Actionable comments posted: 0
🧹 Outside diff range and nitpick comments (5)
CHANGELOG.md (5)
Line range hint
1-24
: Documentation format needs improvementThe changelog header section should include:
- A clear statement of supported Go versions
- Minimum supported node requirements
- Any critical upgrade requirements
Consider adding this information in a standardized header section.
# Changelog All notable changes to Osmosis will be documented in this file. ## Supported Environments - Go version: 1.21+ - Node requirements: {cpu, ram, disk specs} ## Critical Upgrade Notes - Node operators must... - API users should...
Line range hint
45-85
: Breaking changes need more migration guidanceThe v27.0.0 state breaking changes section lists significant changes but lacks sufficient migration guidance for:
- Smart account module activation
- ProtoRev distribution changes
- Changes to gauge creation requirements
Consider adding a "Migration Guide" subsection under each major version that details required actions for node operators, API consumers, and smart contract developers.
Line range hint
86-150
: Inconsistent PR reference formatThe changelog has inconsistent formatting for PR references:
- Some use full URLs:
[#8682](https://github.com/osmosis-labs/osmosis/pull/8682)
- Others use just PR numbers:
[#8734]
- Some lack descriptions of the actual changes
Standardize on full URLs with descriptive text of the changes.
* [#8734](https://github.com/osmosis-labs/osmosis/pull/8734) Update CosmWasm VM to latest version to improve contract execution performance and security
Line range hint
151-200
: Add impact assessment for security updatesSecurity-related changes should include:
- Severity level
- Potential impact
- Whether user action is required
- Timeline for required actions
This helps users properly prioritize updates.
### Security * [#8777](https://github.com/osmosis-labs/osmosis/pull/8777) CRITICAL: Fix state export for gov module constitution - Severity: Critical - Impact: Could lead to incorrect governance state after chain export - Action Required: Node operators must upgrade before block X - Timeline: Must be completed by YYYY-MM-DD
Line range hint
201-250
: Improve version comparison documentationFor major version changes (like v26 to v27), add a high-level summary section that outlines:
- Key new features and capabilities
- Breaking changes summary
- Performance impact
- Required configuration changes
This helps users quickly understand the impact of the upgrade.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM
(cherry picked from commit 66c98cf)
What is the purpose of the change
Updates changelog for v27.0.0 release