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(changelog): move changelog items to respective location #19001

Merged
merged 5 commits into from
Jan 10, 2024

Conversation

tac0turtle
Copy link
Member

Description

This pr moves items from the root level changelog to the modules changelog to better identify breaking items for modules


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

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

@tac0turtle tac0turtle force-pushed the marko/changelog_checks branch from f8f9e1c to a723e71 Compare January 10, 2024 10:39
@tac0turtle tac0turtle marked this pull request as ready for review January 10, 2024 10:40
@tac0turtle tac0turtle requested a review from a team as a code owner January 10, 2024 10:40
Copy link
Contributor

coderabbitai bot commented Jan 10, 2024

Walkthrough

The recent updates to the codebase involve substantial enhancements and API-breaking changes across various modules. Key changes include the introduction of new features such as multiple transaction broadcasting, new message types, and improved error handling. Deprecated functions have been removed, and gas efficiency has been optimized. Additionally, there have been shifts towards using collections, modifications to state management, and adjustments for IBC compatibility, all indicative of a move towards more modular and robust architecture.

Changes

File(s) Change Summary
x/auth/..., client/..., runtime/..., baseapp/..., types/..., crypto/keys/..., client/keys/..., app/..., types/simulation/..., x/bank/testutil/..., server/... Added new flags, message types, and command functionalities; removed deprecated functions; migrated modules to own go.mod; adjusted methods and parameters.
x/auth/CHANGELOG.md Enhanced broadcasting for multiple transactions; added start time for vesting accounts; improved gas efficiency and CLI commands; removed StdTxConfig.
x/authz/CHANGELOG.md Moved AcceptResponse function; changed Updated field type.
x/bank/CHANGELOG.md Introduced MsgBurn; improved error handling; changed BurnCoins to require an address.
x/distribution/CHANGELOG.md Removed state management methods; updated AllocateTokens; improved error handling in reward calculation methods.
x/feegrant/CHANGELOG.md Updated to use collections; changed method parameters to strings; removed global bech32 usage; updated ValidateBasic in line with RFC001.
x/gov/CHANGELOG.md Improved genesis validation process.
x/nft/CHANGELOG.md Corrected typo; updated feature descriptions for queries.
x/slashing/CHANGELOG.md Enhanced performance; used collections; API breaking changes to Params state and ValidatorSigningInfo.
x/staking/CHANGELOG.md Improved error handling; added key_rotation_fee; replaced HistoricalInfo with HistoricalRecord; used collections; removed methods; state-breaking changes.
x/tx/CHANGELOG.md Added nested message support; updated HandlerMap and textual types; API breaking changes including renaming and type 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?

Share

Tips

Chat

There are 3 ways to chat with CodeRabbit:

Note: Auto-reply has been disabled for this repository by the repository owner. The CodeRabbit bot will not respond to your comments unless it is explicitly tagged.

  • 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 tests 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 from git and render them as a table.
    • @coderabbitai show all the console.log statements in this repository.
    • @coderabbitai read src/utils.ts and generate unit tests.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

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 as PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger a review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • The JSON schema for the configuration file is available here.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/coderabbit-overrides.v2.json

CodeRabbit Discord Community

Join our Discord Community to get help, request features, and share feedback.

CHANGELOG.md Outdated Show resolved Hide resolved
Copy link
Contributor

@samricotta samricotta left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If that one question is fine then then all good

Comment on lines +41 to +42
Every Module contains its own CHANGELOG.md. Please refer to the module you are interested in.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please ensure that all module-specific CHANGELOG.md files are updated accordingly with the changes mentioned here to maintain consistency across documentation.

* (staking) [#18506](https://github.com/cosmos/cosmos-sdk/pull/18506) Detect the length of the ed25519 pubkey in CreateValidator to prevent panic.
* (tx) [#18772](https://github.com/cosmos/cosmos-sdk/pull/18772) Remove misleading gas wanted from tx simulation failure log.
* (tx) [#18852](https://github.com/cosmos/cosmos-sdk/pull/18852) Add `WithFromName` to tx factory.
* (client/tx) [#18852](https://github.com/cosmos/cosmos-sdk/pull/18852) Add `WithFromName` to tx factory.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The shell script did not find any references to appd export in UPGRADING.md. This suggests that the CLI breaking change regarding appd export is not documented in UPGRADING.md as the review comment suggested it should be. Ensure that users are aware of the new command to use.

@tac0turtle tac0turtle enabled auto-merge January 10, 2024 16:46
@tac0turtle tac0turtle added this pull request to the merge queue Jan 10, 2024
Merged via the queue into main with commit 7412e78 Jan 10, 2024
51 of 52 checks passed
@tac0turtle tac0turtle deleted the marko/changelog_checks branch January 10, 2024 16:50
relyt29 pushed a commit to relyt29/cosmos-sdk that referenced this pull request Jan 22, 2024
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.

5 participants