-
Notifications
You must be signed in to change notification settings - Fork 3.6k
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: sync changelog with latest releases #21658
Conversation
WalkthroughWalkthroughThe pull request introduces several updates to the CHANGELOG.md file for the Cosmos SDK, focusing on enhancing the organization and clarity of documented changes. Key adjustments include the removal of certain entries in the Features and Improvements sections, updates to the Bug Fixes section for clarity, and an expansion of the API Breaking Changes section. Notably, a new Changes
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
|
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: 1
Review details
Configuration used: .coderabbit.yml
Review profile: CHILL
Files selected for processing (1)
- CHANGELOG.md (6 hunks)
Additional context used
Path-based instructions (1)
CHANGELOG.md (1)
Pattern
**/*.md
: "Assess the documentation for misspellings, grammatical errors, missing documentation and correctness"
Additional comments not posted (4)
CHANGELOG.md (4)
Line range hint
28-29
: LGTM!Updating the "Unreleased" section header with the new release version and date looks good.
214-214
: Looks good, but please verify thread-safetyAdding the new
SelectBy
method to theMempool
interface seems like a useful feature. The comment indicates this method is thread-safe to use which is great.Can you please provide some more details or a test demonstrating how the thread-safety of this method is ensured? It's an important aspect to validate for a concurrent component like the mempool.
213-213
: API improvementReplacing the
AddGenesisAccount
function withAddGenesisAccounts
is a good change.While it's a breaking change to remove
AddGenesisAccount
, having a single function that accepts multiple accounts is more convenient and efficient than callingAddGenesisAccount
repeatedly.This simplifies the API for the common case of adding multiple genesis accounts. Nice work!
230-230
: Deprecation looks goodDeprecating the
String()
methods on address types that use the deprecated globalsdk.Config
makes sense.The deprecation notice clearly points users to using an
address.Codec
instead for safely turning addresses into strings, which is the right approach.This is a well documented deprecation with a straightforward replacement. Thanks for keeping the codebase clean of deprecated usage!
@@ -134,6 +124,9 @@ Every module contains its own CHANGELOG.md. Please refer to the module you are i | |||
* (baseapp) [#20380](https://github.com/cosmos/cosmos-sdk/pull/20380) Enhanced OfferSnapshot documentation. | |||
* (client) [#20771](https://github.com/cosmos/cosmos-sdk/pull/20771) Remove `ReadDefaultValuesFromDefaultClientConfig` from `client` package. (It was introduced in `v0.50.6` as a quick fix). | |||
* (grpcserver) [#20945](https://github.com/cosmos/cosmos-sdk/pull/20945) Adds error handling for out-of-gas panics in grpc query handlers. | |||
* (internal) [#21412](https://github.com/cosmos/cosmos-sdk/pull/21412) Using unsafe.String and unsafe.SliceData. |
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.
More info needed on unsafe usage
The change to use unsafe.String
and unsafe.SliceData
jumps out as needing extra scrutiny.
Unsafe operations bypass Go's type safety and memory protections. They can be justified in performance-critical code but must be used very carefully.
Can you elaborate on the specific use cases for these unsafe function calls, and what precautions are being taken to ensure they are used safely without risking panics or memory corruption?
Some more code context and safety analysis would be helpful here. Let's make sure this unsafe usage is truly necessary and safe.
* main: docs(client/debug): correct `debug raw-bytes` command example (#21671) build: don't reinstall golangci-lint if already installed (#21662) refactor(server/v2): kill viper from server components (#21663) chore: sync changelog with latest releases (#21658) refactor: remove viper as a direct dependency (#21635) ci: centralized job for rocksdb libaries cache (#21657) fix: remove stray fmt.Println (#21661)
Description
Sync changelog after v0.52.0-beta.1 release
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.md
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...
Summary by CodeRabbit
SelectBy
method in theMempool
interface, improving thread safety.String()
method on several address types, encouraging the use ofaddress.Codec
.