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: add releases to changelog #21831

Merged
merged 3 commits into from
Sep 20, 2024
Merged

chore: add releases to changelog #21831

merged 3 commits into from
Sep 20, 2024

Conversation

julienrbrt
Copy link
Member

@julienrbrt julienrbrt commented Sep 20, 2024

Description

Add changelogs to main


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

  • New Features

    • Introduced module-hash-by-height and bulk-add-genesis-account commands in the CLI for enhanced functionality.
    • Added LegacyDec collection value in the types/collections module.
    • Enhanced MsgMultiSend event with a new Sender attribute.
  • Improvements

    • Improved error messages for genesis validation.
    • Updated API to marshal type field as a proto message URL in queries.
  • Bug Fixes

    • Deprecated methods and configurations to streamline functionality.
  • Version Updates

    • New versions v0.50.10, v0.47.14, and v2.0.0-beta.5 released with various enhancements.

Copy link
Contributor

coderabbitai bot commented Sep 20, 2024

Warning

Rate limit exceeded

@julienrbrt has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 18 minutes and 1 seconds before requesting another review.

How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.

Please see our FAQ for further information.

Commits

Files that changed from the base of the PR and between b29b50d and f4be54e.

Walkthrough

Walkthrough

The pull request introduces several updates across various modules, including new CLI commands for enhanced debugging and account management, improvements to event clarity, and deprecations of certain methods and configurations. It also updates the changelog to reflect new versions and API breaking changes, particularly in the client and transaction modules, highlighting significant adjustments to how address codecs and JSON encoding are handled.

Changes

File Change Summary
CHANGELOG.md Updated to include new features, improvements, and bug fixes, including CLI commands and deprecations.
client/v2/CHANGELOG.md Added section for API Breaking Changes; removed address codecs from autocli.AppOptions.
x/tx/CHANGELOG.md Introduced AminoNameAsTypeURL option in the Amino JSON encoder; clarified previous version changes.

Possibly related PRs

Suggested labels

backport/v0.50.x, backport/v0.52.x


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>, please review it.
    -- 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 gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    -- @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.

@julienrbrt julienrbrt assigned julienrbrt and unassigned julienrbrt Sep 20, 2024
@julienrbrt julienrbrt marked this pull request as draft September 20, 2024 10:50
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: 0

Outside diff range and nitpick comments (1)
client/v2/CHANGELOG.md (1)

46-49: Improve readability by adding a comma.

The new "API Breaking Changes" section and the description of the breaking change are clear and well-written.

To improve readability, consider adding a comma after "Instead":

- Instead client/v2 uses the address codecs present in the context
+ Instead, client/v2 uses the address codecs present in the context
Tools
LanguageTool

[uncategorized] ~48-~48: A comma may be missing after the conjunctive/linking adverb ‘Instead’.
Context: ...autocli.AppOptionsandflag.Builder`. Instead client/v2 uses the address codecs prese...

(SENT_START_CONJUNCTIVE_LINKING_ADVERB_COMMA)

Review details

Configuration used: .coderabbit.yml
Review profile: CHILL

Commits

Files that changed from the base of the PR and between aa90bb4 and b29b50d.

Files selected for processing (3)
  • CHANGELOG.md (2 hunks)
  • client/v2/CHANGELOG.md (1 hunks)
  • x/tx/CHANGELOG.md (1 hunks)
Additional context used
Path-based instructions (3)
CHANGELOG.md (1)

Pattern **/*.md: "Assess the documentation for misspellings, grammatical errors, missing documentation and correctness"

client/v2/CHANGELOG.md (1)

Pattern **/*.md: "Assess the documentation for misspellings, grammatical errors, missing documentation and correctness"

x/tx/CHANGELOG.md (1)

Pattern **/*.md: "Assess the documentation for misspellings, grammatical errors, missing documentation and correctness"

LanguageTool
client/v2/CHANGELOG.md

[uncategorized] ~48-~48: A comma may be missing after the conjunctive/linking adverb ‘Instead’.
Context: ...autocli.AppOptionsandflag.Builder`. Instead client/v2 uses the address codecs prese...

(SENT_START_CONJUNCTIVE_LINKING_ADVERB_COMMA)

Additional comments not posted (11)
client/v2/CHANGELOG.md (2)

50-51: Verify the release date for v2.0.0-beta.5.

The addition of the new version section for v2.0.0-beta.5 looks good.

However, please double-check the release date. 2024-09-18 seems to be in the future. Is this intentional or a typo?


56-56: Verify the release date for v2.0.0-beta.4.

Referencing the previous version v2.0.0-beta.4 in the changelog provides good context.

However, similar to the v2.0.0-beta.5 release date, the date for v2.0.0-beta.4 (2024-07-16) also seems to be in the future. Please double-check if this is intentional or a typo.

x/tx/CHANGELOG.md (2)

36-40: LGTM!

The new release entry is well-formatted and includes a clear description of the improvement along with a reference to the relevant pull request.


42-46: LGTM!

The clarification about using sync.Map for concurrent writes in the getSignersFuncs map and the reminder to call Validate when creating the Context are valuable additions to the changelog entry.

CHANGELOG.md (7)

240-247: Changes look good!

The new CLI commands and collection value additions are clearly described and seem useful. I don't see any issues with these changes.


248-253: Improvements look good!

The added event attribute, improved error messages, and enhanced testability all seem like worthwhile improvements. I don't see any downsides to these changes.


Line range hint 254-261: Changes look good!

The new method, event attribute, and migration handler all seem like useful additions that extend functionality in reasonable ways. The MigrateHandler lays good groundwork for future migration capabilities. I don't see any issues with these changes.


Line range hint 263-266: Bug fix looks good!

Correcting the db_backend config lookup fallback is a straightforward fix worth including in the release. I don't see any issues with this change.


Line range hint 268-283: Changes look good!

The new features like custom max gas and simd prune UX improvement are nice additions. The bug fixes for event querying, nil account panics, snapshotter errors, and the account address cache disabling option all improve the robustness and flexibility of the system. The CometBFT version bump also helps keep things up-to-date. Overall this looks like a solid set of changes for the release.


Line range hint 285-309: Changes look excellent!

This release packs in a lot of great new functionality with the snapshot features, circuit breaker, new events and commands, and the BaseApp cleanup method. The various improvements to the store, simulation, and error handling are also very useful.

Fixing the security vulnerability and address validation issue is crucial. The CometBFT version bump and IAVL fix also help keep things running smoothly.

Overall this looks like a significant and valuable set of changes for the release. Great work!


Line range hint 311-325: Changes look solid!

The GetAllVersions addition to the app store and the evidence decoding support in the codec are handy new capabilities to have.

The various fixes for gRPC reflection, consensus params in begin/end blockers, and LegacyAminoPubKey JSON decoding are important corrections that improve the reliability of the system.

The debug error messages are a nice quality-of-life improvement for developers troubleshooting issues.

Overall this set of changes, while relatively small, makes meaningful improvements. Looks good to me!

@julienrbrt julienrbrt marked this pull request as ready for review September 20, 2024 10:55
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants