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.

Sign up for GitHub

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

Jump to bottom

chore: changelog fixes #8423

Merged
merged 2 commits into from
Jun 24, 2024
Merged

chore: changelog fixes #8423

merged 2 commits into from
Jun 24, 2024

Conversation

czarcas7ic
Copy link
Member

Closes: #XXX

What is the purpose of the change

Add a description of the overall background and high level changes that this PR introduces

(E.g.: This pull request improves documentation of area A by adding ....

Testing and Verifying

(Please pick one of the following options)

This change is a trivial rework / code cleanup without any test coverage.

(or)

This change is already covered by existing tests, such as (please describe tests).

(or)

This change added tests and can be verified as follows:

(example:)

  • Added unit test that validates ...
  • Added integration tests for end-to-end deployment with ...
  • Extended integration test for ...
  • Manually verified the change by ...

Documentation and Release Note

  • Does this pull request introduce a new feature or user-facing behavior changes?
  • Changelog entry added to Unreleased section of CHANGELOG.md?

Where is the change documented?

  • Specification (x/{module}/README.md)
  • Osmosis documentation site
  • Code comments?
  • N/A

@czarcas7ic czarcas7ic added V:state/compatible/backport State machine compatible PR, should be backported A:backport/v25.x backport patches to v25.x branch labels Jun 21, 2024
@coderabbitai coderabbitai
Copy link
Contributor

coderabbitai bot commented Jun 21, 2024 •
edited
Loading

Walkthrough

The osmosis project introduces updates in version v25.1.3, focusing on IBC acknowledgements and SDK performance improvements. Notably, unneeded IBC acknowledgements time was removed, and the checkTx was replaced with a cached tx decoder, enhancing SDK efficiency. Version v25.1.2 had earlier addressed cache reset on pool creation and Comet bump for an edge case.

Changes

File Change Summary
CHANGELOG.md Documented changes for versions v25.1.3 (IBC acknowledgements and SDK performance) and v25.1.2 (cache reset, Comet bump).

Poem

In the world of Osmo bright,
😊 IBC flows trimmed just right,
With caches reset and code so sleek,
SDK's speed now at its peak. 🚀
Let's cheer for changes, big and small,
For in this realm, we stand tall! 🎉🐇

Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between ef8553b and b682787.

Files selected for processing (1)
  • CHANGELOG.md (1 hunks)
Additional context used
Markdownlint
CHANGELOG.md

1090-1090: Expected: h3; Actual: h4 (MD001, heading-increment)
Heading levels should only increment by one level at a time

1102-1102: Expected: h3; Actual: h4 (MD001, heading-increment)
Heading levels should only increment by one level at a time

1111-1111: Expected: h3; Actual: h4 (MD001, heading-increment)
Heading levels should only increment by one level at a time

1116-1116: Expected: h3; Actual: h4 (MD001, heading-increment)
Heading levels should only increment by one level at a time

1168-1168: Expected: h3; Actual: h4 (MD001, heading-increment)
Heading levels should only increment by one level at a time

429-429: Punctuation: '.' (MD026, no-trailing-punctuation)
Trailing punctuation in heading

692-692: null (MD034, no-bare-urls)
Bare URL used

750-750: null (MD034, no-bare-urls)
Bare URL used

1331-1331: null (MD042, no-empty-links)
No empty links

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

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.

coderabbitai[bot]
coderabbitai bot reviewed Jun 21, 2024
View reviewed changes
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

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

60-60: Highlight Recent Changes in Changelog

It's good practice to highlight the recent changes in the changelog for better visibility. Consider adding a brief description or a "New in this version" section at the beginning of version v25.1.2 to outline the key changes, such as the Comet update and cache reset issue resolution.

CHANGELOG.md Outdated Show resolved Hide resolved
coderabbitai[bot]
coderabbitai bot reviewed Jun 21, 2024
View reviewed changes
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

CHANGELOG.md Show resolved Hide resolved
PaddyMc
PaddyMc approved these changes Jun 21, 2024
View reviewed changes
Copy link
Collaborator

@PaddyMc PaddyMc left a comment

Choose a reason for hiding this comment

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

❤️

@czarcas7ic czarcas7ic closed this Jun 24, 2024
@czarcas7ic czarcas7ic reopened this Jun 24, 2024
@czarcas7ic czarcas7ic merged commit 064fcd7 into main Jun 24, 2024
1 check passed
@czarcas7ic czarcas7ic deleted the adam/changelog-fixes branch June 24, 2024 16:00
mergify bot pushed a commit that referenced this pull request Jun 24, 2024
@czarcas7ic @mergify
chore: changelog fixes (#8423)
46e26ee 
* changelog

* fix

(cherry picked from commit 064fcd7)
@mergify mergify bot mentioned this pull request Jun 24, 2024
Merged
6 tasks
czarcas7ic added a commit that referenced this pull request Jun 24, 2024
@mergify @czarcas7ic
chore: changelog fixes (#8423) (#8440)
624b811 
* changelog

* fix

(cherry picked from commit 064fcd7)

Co-authored-by: Adam Tucker <adam@osmosis.team>
This was referenced Oct 5, 2024
Merged
Merged
Merged
@coderabbitai coderabbitai bot mentioned this pull request Oct 17, 2024
Merged
6 tasks
@coderabbitai coderabbitai bot mentioned this pull request Oct 30, 2024
Merged
This was referenced Nov 13, 2024
Closed
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@coderabbitai coderabbitai[bot] coderabbitai[bot] left review comments

@PaddyMc PaddyMc PaddyMc approved these changes

Assignees
No one assigned
Labels
A:backport/v25.x backport patches to v25.x branch V:state/compatible/backport State machine compatible PR, should be backported
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@czarcas7ic @PaddyMc