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: v6.7.0 stable release upgrade handler #2622

Merged
merged 1 commit into from
Nov 5, 2024
Merged

Conversation

gsk967
Copy link
Collaborator

@gsk967 gsk967 commented Nov 5, 2024

Description

v6.7 Stable release upgrade


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
  • added ! to the type prefix if API or client breaking change
  • added appropriate labels to the PR
  • targeted the correct branch (see PR Targeting)
  • provided a link to the relevant issue or specification
  • added a changelog entry to CHANGELOG.md
  • included comments for documenting Go code
  • updated the relevant documentation or specification
  • reviewed "Files changed" and left comments if necessary
  • 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
  • reviewed API design and naming
  • reviewed documentation is accurate
  • reviewed tests and test coverage
  • manually tested (if applicable)

Summary by CodeRabbit

  • New Features

    • Transitioned from release candidate version 6.7.0-rc1 to stable version 6.7.0.
    • Updated several dependencies, including cosmos SDK, cometbft, wasmvm, and ibc-go.
  • Bug Fixes

    • Resolved issues related to token pricing for blacklisted assets and cometbft-db downgrades.
  • Documentation

    • Updated release notes with instructions for restarting the Price Feeder post-upgrade and ensuring correct library linking for libwasmvm.

@gsk967 gsk967 requested a review from a team as a code owner November 5, 2024 11:11
Copy link
Contributor

coderabbitai bot commented Nov 5, 2024

Walkthrough

The pull request updates the changelog and release notes to reflect the stable release of version 6.7.0, replacing the previous release candidate version 6.7.0-rc1. It includes updates to various dependencies and addresses specific bug fixes. Additionally, the upgrade registration in the UmeeApp class is modified to register the new stable version, while previous upgrade handlers remain unchanged. The overall structure of the documentation and code is maintained, ensuring clarity and continuity.

Changes

File Change Summary
CHANGELOG.md Updated version from 6.7.0-rc1 to 6.7.0, added dependency updates, and noted bug fixes related to token price and cometbft-db.
RELEASE_NOTES.md Changed version designation from v6.7.0-rc1 to v6.7.0, updated dependency versions, and emphasized the need to restart the Price Feeder post-upgrade.
app/upgrades.go Modified RegisterUpgradeHandlers to register version v6.7.0 instead of v6.7.0-rc1. Previous upgrade handlers remain unchanged but are contextually updated to reflect the new stable version.

Possibly related PRs

Suggested labels

T:Dependencies, A:Automerge

Suggested reviewers

  • abdulgig

Poem

In the garden where upgrades bloom,
A stable version dispels the gloom.
With dependencies spruced and bright,
We hop along with pure delight!
So raise a cheer for version six point seven,
A leap for all, a code-filled heaven! 🐇✨


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.

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

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 (3)
RELEASE_NOTES.md (2)

Line range hint 24-26: Consider adding Price Feeder version verification step.

While the Price Feeder update requirement is noted, it would be helpful to add a command for users to verify they're running the correct version.

Consider adding:

 Update Price Feeder to `umee/2.4.4+`.
+
+To verify your Price Feeder version:
+```shell
+price-feeder version
+```

 NOTE: after the upgrade, you should restart your Price Feeder. We observed that Price Feeder doesn't correctly re-establish a connection after the chain upgrade.

Line range hint 28-34: Consider adding libwasmvm version verification step.

While the libwasmvm update instructions are comprehensive, adding a verification step would help users confirm they have the correct version installed.

Consider adding:

 You don't need to do anything if you are using our Docker image.
+
+To verify your libwasmvm version:
+```shell
+ldd $(which umeed) | grep wasmvm
+```
+The output should show `libwasmvm.$(uname -m).so => /usr/lib/libwasmvm.$(uname -m).so`
app/upgrades.go (1)

57-57: Consider adding upgrade documentation.

While the upgrade handler is correctly implemented, consider adding inline documentation to describe:

  • The purpose of this upgrade (RC to stable transition)
  • Any specific actions nodes need to take during the upgrade

Example documentation:

+       // v6.7.0 upgrades the network from release candidate to stable version
+       // No store upgrades or migrations are needed
        app.registerUpgrade("v6.7.0", upgradeInfo, nil, nil, nil)
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between 028875d and 2e699cd.

📒 Files selected for processing (3)
  • CHANGELOG.md (1 hunks)
  • RELEASE_NOTES.md (2 hunks)
  • app/upgrades.go (1 hunks)
✅ Files skipped from review due to trivial changes (1)
  • CHANGELOG.md
🔇 Additional comments (3)
RELEASE_NOTES.md (2)

Line range hint 9-21: LGTM! Version and highlights are well documented.

The version update and dependency changes are clearly documented with specific version numbers, making it easy for users to understand the changes in this stable release.


22-22: LGTM! Upgrade title is correctly updated.

The Cosmovisor upgrade title has been properly updated to reflect the stable version.

app/upgrades.go (1)

57-57: LGTM! Simple upgrade handler registration.

The upgrade handler for v6.7.0 is correctly registered using the registerUpgrade helper function with no store upgrades or migrations, which aligns with the PR's objective of transitioning from RC to stable release.

Let's verify the upgrade handler registration pattern matches other simple upgrades:

✅ Verification successful

Upgrade handler registration follows consistent pattern

The verification confirms that the v6.7.0 upgrade handler follows the same pattern as other simple upgrades (v6.3 and v6.5), using registerUpgrade with nil parameters for store upgrades and migrations. This is appropriate for a stable release transition that doesn't require state changes.

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Verify that other simple upgrades follow the same pattern
# Expected: Similar upgrade registrations for v6.3 and v6.5

rg "registerUpgrade\(\"v6\.[357]" -A 1

Length of output: 387

@gsk967 gsk967 changed the title chore: v6.7 stable release upgrade handler chore: v6.7.0 stable release upgrade handler Nov 5, 2024
Copy link

codecov bot commented Nov 5, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 62.00%. Comparing base (7f05ad4) to head (2e699cd).
Report is 548 commits behind head on main.

Additional details and impacted files

Impacted file tree graph

@@             Coverage Diff             @@
##             main    #2622       +/-   ##
===========================================
- Coverage   75.38%   62.00%   -13.39%     
===========================================
  Files         100      275      +175     
  Lines        8025    19628    +11603     
===========================================
+ Hits         6050    12171     +6121     
- Misses       1589     6685     +5096     
- Partials      386      772      +386     
Files with missing lines Coverage Δ
app/upgrades.go 44.02% <100.00%> (ø)

... and 215 files with indirect coverage changes

@gsk967 gsk967 added this pull request to the merge queue Nov 5, 2024
Merged via the queue into main with commit dafb62b Nov 5, 2024
26 of 29 checks passed
@gsk967 gsk967 deleted the sai/v6_7_upgrade branch November 5, 2024 15:13
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.

2 participants