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: prepare x/tx changelog #20015

Merged
merged 2 commits into from
Apr 12, 2024
Merged

chore: prepare x/tx changelog #20015

merged 2 commits into from
Apr 12, 2024

Conversation

julienrbrt
Copy link
Member

@julienrbrt julienrbrt commented Apr 11, 2024

Description

Closes: #20004


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

Summary by CodeRabbit

  • New Features
    • Introduced an "inline_json" option for the Amino JSON encoder.
  • Bug Fixes
    • Resolved issues with Amino marshalling error messages.
    • Fixed handling of denominations containing commas in the system.

@julienrbrt julienrbrt requested a review from a team as a code owner April 11, 2024 15:53
Copy link
Contributor

coderabbitai bot commented Apr 11, 2024

Walkthrough

Walkthrough

The update to the x/tx module in the Cosmos SDK includes version 0.13.2, introducing features like the "inline_json" option for the Amino JSON encoder and fixes for issues such as Amino marshalling errors and handling of denominations with commas. These changes align with the Cosmos SDK's semantic versioning principles.

Changes

File Path Change Summary
x/tx/CHANGELOG.md Updated to reflect version 0.13.2 changes, including the "inline_json" option and error fixes.

Assessment against linked issues

Objective Addressed Explanation
Update x/tx changelog with date of today (#20004) The changelog now includes the date of today as required by the linked issue.
Tag x/tx (#20004) It is unclear from the provided information whether the tagging of x/tx has been done.

Recent Review Details

Configuration used: .coderabbit.yml

Commits Files that changed from the base of the PR and between 3c38330 and c77bb5d.
Files selected for processing (1)
  • x/tx/CHANGELOG.md (3 hunks)
Additional Context Used
Path-based Instructions (1)
x/tx/CHANGELOG.md (1)

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

Additional comments not posted (5)
x/tx/CHANGELOG.md (5)

36-36: Ensure the "Unreleased" section is correctly formatted. It appears there might be a formatting issue with the markdown syntax.

Verification successful

The output from the shell script shows the context around the "Unreleased" section in the x/tx/CHANGELOG.md file. The section appears directly above the entry for version v0.13.2, and there are no visible markdown syntax errors in the provided output. The "Unreleased" section is formatted correctly as a markdown header, and there are no additional characters or formatting issues that would disrupt the markdown rendering.

Based on this information, the "Unreleased" section is correctly formatted, and there are no markdown syntax issues around this section in the changelog file.

Scripts Executed

The following scripts were executed for the analysis:


Script:

#!/bin/bash
# Check for markdown syntax errors around the "Unreleased" section.
rg --context 5 '## \[Unreleased\]' x/tx/CHANGELOG.md

Length of output: 300


36-37: The new version entry for v0.13.2 is correctly dated and linked. Ensure that the release tag URL is correct and accessible.


37-37: The entry for the "inline_json" option in the Amino JSON encoder is well-documented with relevant issue and pull request links. Consider adding a brief description of the feature for better clarity.


Line range hint 44-44: The entry about using a hybrid resolver instead of only the protov2 registry is concise. Ensure that the technical details are accurate and that the change is reflected in the linked pull request.


48-48: The bug fix regarding Amino marshalling error messages is important. Verify that the fix addresses the issue completely and that no related error messages are suppressed unintentionally.


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.

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.
  • Please see the configuration documentation for more information.
  • 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/schema.v2.json

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.

x/tx/CHANGELOG.md Outdated Show resolved Hide resolved
@julienrbrt julienrbrt added this pull request to the merge queue Apr 12, 2024
Merged via the queue into main with commit 4ad0821 Apr 12, 2024
55 checks passed
@julienrbrt julienrbrt deleted the julien/preparextx branch April 12, 2024 11:13
alpe added a commit to alpe/cosmos-sdk that referenced this pull request Apr 15, 2024
* main: (25 commits)
  fix: Implement gogoproto customtype to secp256r1 keys (cosmos#20027)
  fix(x/epochs): avoid invalid epoch duration in simulation (cosmos#20030)
  fix(x/bank): align query with multi denoms for send-enabled (cosmos#20028)
  refactor(x/slashing)!: remove Accounts String (cosmos#20026)
  refactor(x/evidence)!: remove Address.String() (cosmos#20016)
  chore: make telemetry consistent (cosmos#20025)
  chore: prepare x/tx changelog (cosmos#20015)
  build(deps): Bump actions/add-to-project from 1.0.0 to 1.0.1 (cosmos#20018)
  feat(x/bank): support depinject for send restrictions (cosmos#20014)
  feat: Conditionally emit metrics based on enablement (cosmos#19903)
  fix(store): fix the typo (cosmos#20011)
  docs(x/feegrant): fix allowance typo (cosmos#20000)
  chore(confix): update latest config value (cosmos#20012)
  refactor(x/auth): auth module can recognize x/accounts account (cosmos#20002)
  fix(mempool): use no-op mempool as default (cosmos#19970)
  fix(simapp): add epoch store to upgrade (cosmos#20007)
  test(kv): add unit tests for the helpers functions kv.AssertKeyAtLeas… (cosmos#19965)
  feat(x/tx): Rename custom Amino JSON encoder to "inline_json" (cosmos#19919)
  refactor(x/auth): use transaction service (cosmos#19967)
  fix(client/v2): add encoder for `cosmos.base.v1beta1.DecCoin` (cosmos#19976)
  ...
alpe added a commit that referenced this pull request Apr 15, 2024
* main:
  fix: Implement gogoproto customtype to secp256r1 keys (#20027)
  fix(x/epochs): avoid invalid epoch duration in simulation (#20030)
  fix(x/bank): align query with multi denoms for send-enabled (#20028)
  refactor(x/slashing)!: remove Accounts String (#20026)
  refactor(x/evidence)!: remove Address.String() (#20016)
  chore: make telemetry consistent (#20025)
  chore: prepare x/tx changelog (#20015)
  build(deps): Bump actions/add-to-project from 1.0.0 to 1.0.1 (#20018)
  feat(x/bank): support depinject for send restrictions (#20014)
  feat: Conditionally emit metrics based on enablement (#19903)
  fix(store): fix the typo (#20011)
  docs(x/feegrant): fix allowance typo (#20000)
  chore(confix): update latest config value (#20012)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Tag x/tx 0.13.2
3 participants