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

build: update tokio to 1.40 and release 1.2.1 #107

Merged
merged 1 commit into from
Oct 7, 2024
Merged

Conversation

lklimek
Copy link
Collaborator

@lklimek lklimek commented Oct 7, 2024

Issue being fixed or feature implemented

We want new release

What was done?

  • tokio 1.40
  • updated version number
  • fixed release script

How Has This Been Tested?

Breaking Changes

Checklist:

  • I have performed a self-review of my own code
  • I have commented my code, particularly in hard-to-understand areas
  • I have added or updated relevant unit/integration/functional/e2e tests
  • I have made corresponding changes to the documentation

For repository code-owners and collaborators only

  • I have assigned this pull request to a milestone

Summary by CodeRabbit

  • New Features

    • Updated package version to 1.2.1+1.3.0 for improved functionality.
  • Bug Fixes

    • Updated dependency versions for tokio-util and tokio to enhance performance and security.
  • Chores

    • Enhanced versioning script for better clarity and management of versioning details.

Copy link
Contributor

coderabbitai bot commented Oct 7, 2024

Walkthrough

The changes involve modifications to the Cargo.toml files for the main workspace and the tenderdash-abci package, updating their respective versions and dependencies. The workspace version is updated from 1.1.0 to 1.2.1+1.3.0, while the tenderdash-abci package sees updates to its tokio and tokio-util dependencies, including the removal of deprecated features. Additionally, the scripts/release.sh script has been updated to enhance version management, including renaming a variable and modifying version construction logic.

Changes

File Change Summary
Cargo.toml Updated workspace package version from 1.1.0 to 1.2.1+1.3.0.
abci/Cargo.toml Updated tokio-util from 0.7.10 to 0.7.12, tokio from 1.37.0 to 1.40, and tokio in dev-dependencies from 1.39 to 1.40. Marked std feature as deprecated.
scripts/release.sh Renamed variable from rs_tenderdash_abci_version to rs_tenderdash_abci_version_build. Modified version construction logic and updated echo and sed commands accordingly.

Poem

In the code where rabbits play,
Versions hop and dance today.
Dependencies fresh, a joyful cheer,
With scripts that sing, our path is clear!
A leap in logic, a bound in time,
In every change, a reason to rhyme! 🐇✨


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
Member

@shumkov shumkov left a comment

Choose a reason for hiding this comment

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

👍

@lklimek lklimek merged commit aad72f4 into develop Oct 7, 2024
10 of 11 checks passed
@lklimek lklimek deleted the release/1.2.1 branch October 7, 2024 07:34
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 (2)
scripts/release.sh (2)

89-89: Improved version handling, consider adding a comment

The introduction of rs_tenderdash_abci_version_build improves version management by combining the ABCI and Tenderdash versions. This follows semantic versioning practices for pre-release and build metadata.

Consider adding a brief comment explaining the purpose of this combined version string for better maintainability:

-rs_tenderdash_abci_version_build="${rs_tenderdash_abci_version#v}+${td_version}" # remove 'v' if it exists and suffix build mtd
+# Combine ABCI version and Tenderdash version for build metadata
+rs_tenderdash_abci_version_build="${rs_tenderdash_abci_version#v}+${td_version}" # remove 'v' if it exists

97-102: Approve changes with suggestions for improved clarity

The updates to the sed command and the introduction of the rs_tenderdash variable are consistent with the new version handling. However, there are opportunities to improve clarity and maintainability.

Consider the following improvements:

  1. Break down the rs_tenderdash variable construction for better readability:
-    rs_tenderdash="git = \"https:\/\/github.com\/dashpay\/rs-tenderdash-abci\", version = \"$rs_tenderdash_abci_version\", tag = \"v$rs_tenderdash_abci_version_build\""
+    rs_tenderdash_repo="https://github.com/dashpay/rs-tenderdash-abci"
+    rs_tenderdash="git = \"$rs_tenderdash_repo\", version = \"$rs_tenderdash_abci_version\", tag = \"v$rs_tenderdash_abci_version_build\""
  1. Consider using rs_tenderdash_abci_version_build consistently instead of mixing it with rs_tenderdash_abci_version:
-    rs_tenderdash="git = \"$rs_tenderdash_repo\", version = \"$rs_tenderdash_abci_version\", tag = \"v$rs_tenderdash_abci_version_build\""
+    rs_tenderdash="git = \"$rs_tenderdash_repo\", version = \"$rs_tenderdash_abci_version_build\", tag = \"v$rs_tenderdash_abci_version_build\""

These changes will make the script more readable and maintainable.

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between 96d0d1b and 0d31044.

📒 Files selected for processing (3)
  • Cargo.toml (1 hunks)
  • abci/Cargo.toml (2 hunks)
  • scripts/release.sh (1 hunks)
✅ Files skipped from review due to trivial changes (1)
  • Cargo.toml
🧰 Additional context used
🔇 Additional comments (6)
abci/Cargo.toml (4)

82-82: LGTM: tokio dev-dependency update

Updating the tokio dev-dependency to version 1.40 ensures consistency with the main dependency. This is good practice for maintaining parity between development and production environments.


63-66: LGTM: tokio-util dependency update

The update of tokio-util from version 0.7.10 to 0.7.12 is a minor version bump, which is good practice for keeping dependencies up-to-date. This change aligns with the PR objective of updating dependencies.

To ensure compatibility, please run the following command to check for any breaking changes or deprecations:

#!/bin/bash
# Description: Check for breaking changes or deprecations in tokio-util

cargo tree -p [email protected] --depth 0
cargo doc --no-deps --open tokio-util

Review the output for any warnings or deprecation notices related to the features we're using.


Line range hint 67-73: LGTM: tokio dependency update to 1.40

The update of tokio from version 1.37.0 to 1.40 is in line with the PR objective. This minor version update likely includes new features, improvements, and bug fixes.

To ensure compatibility and check for potential performance improvements, please run the following commands:

#!/bin/bash
# Description: Check for breaking changes, deprecations, and performance improvements in tokio

# Check for any breaking changes or deprecations
cargo tree -p [email protected] --depth 0
cargo doc --no-deps --open tokio

# Check the changelog for any performance improvements
curl -sSL https://raw.githubusercontent.com/tokio-rs/tokio/master/tokio/CHANGELOG.md | sed -n '/^# 1.40.0/,/^# 1.37.0/p'

Review the output for any warnings, deprecation notices, or performance improvements related to the features we're using.


Line range hint 1-82: Overall assessment: Changes look good

The updates to the tokio and tokio-util dependencies in this Cargo.toml file are consistent with the PR objectives. The changes follow good practices by keeping dependencies up-to-date and maintaining consistency between main and dev-dependencies. No major issues or concerns were identified during the review.

To ensure the updates don't introduce any unexpected behavior, please run the following command:

Review the output for any test failures or warnings that might be related to the dependency updates.

scripts/release.sh (2)

91-91: Consistent use of new version variable

The echo statement has been updated to use the new rs_tenderdash_abci_version_build variable, providing more accurate information about the version being prepared for release. This change is consistent with the previous modification and improves the script's output clarity.


Line range hint 1-114: Summary: Release script improvements align with PR objectives

The changes to the release script (scripts/release.sh) align well with the PR objectives of facilitating a new release and fixing the release script. The modifications improve version handling, particularly in combining the ABCI and Tenderdash versions, which enhances consistency and follows semantic versioning practices.

Key improvements:

  1. Introduction of rs_tenderdash_abci_version_build for better version management.
  2. Consistent use of the new version variable throughout the script.
  3. Updated sed commands to reflect the new version format in Cargo.toml files.

These changes contribute to a more robust release process, which is crucial for maintaining compatibility with the updated Tokio library (version 1.40) mentioned in the PR objectives.

To further enhance the script, consider implementing the suggested improvements for clarity and maintainability in the previous comments.

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