Skip to content
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

Merged
merged 2 commits into from
Sep 12, 2024
Merged

Conversation

julienrbrt
Copy link
Member

@julienrbrt julienrbrt commented Sep 11, 2024

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

  • 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

  • Improvements
    • Enhanced organization and clarity of the CHANGELOG for better user understanding.
  • Bug Fixes
    • Clarified the behavior of halt height in block commitment, reverting to previous functionality.
    • Retained entry regarding data race in the SDK mempool for ongoing stability.
  • New Features
    • Introduced the SelectBy method in the Mempool interface, improving thread safety.
  • Deprecated
    • Deprecated the String() method on several address types, encouraging the use of address.Codec.

@julienrbrt julienrbrt requested a review from a team as a code owner September 11, 2024 13:19
Copy link
Contributor

coderabbitai bot commented Sep 11, 2024

Walkthrough

Walkthrough

The 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 SelectBy method is added to the Mempool interface, while the String() method on various address types is deprecated.

Changes

File(s) Change Summary
CHANGELOG.md Updated organization and clarity of changes; removed entries in Features and Improvements sections; clarified Bug Fixes; expanded API Breaking Changes.
baseapp/module.go Added SelectBy method to Mempool interface.
types/address.go Deprecated String() method on AccAddress, ValAddress, and ConsAddress.

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
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>.
    • 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 generate interesting stats about this repository and render them as a table.
    • @coderabbitai show all the console.log statements in this repository.
    • @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 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.

Copy link
Contributor

@coderabbitai coderabbitai bot left a 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

Commits

Files that changed from the base of the PR and between aa8bf41 and fc1b9a3.

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

Adding the new SelectBy method to the Mempool 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 improvement

Replacing the AddGenesisAccount function with AddGenesisAccounts 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 calling AddGenesisAccount repeatedly.

This simplifies the API for the common case of adding multiple genesis accounts. Nice work!


230-230: Deprecation looks good

Deprecating the String() methods on address types that use the deprecated global sdk.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.
Copy link
Contributor

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.

@julienrbrt julienrbrt added this pull request to the merge queue Sep 12, 2024
Merged via the queue into main with commit 6afa3c1 Sep 12, 2024
67 checks passed
@julienrbrt julienrbrt deleted the julien/release-notes branch September 12, 2024 06:29
alessio added a commit to alessio/cosmos-sdk that referenced this pull request Sep 12, 2024
alpe added a commit that referenced this pull request Sep 12, 2024
* 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)
@coderabbitai coderabbitai bot mentioned this pull request Oct 16, 2024
12 tasks
@coderabbitai coderabbitai bot mentioned this pull request Nov 8, 2024
12 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants