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

4.0.0 release #783

Merged
merged 7 commits into from
Dec 21, 2024
Merged

4.0.0 release #783

merged 7 commits into from
Dec 21, 2024

Conversation

khancode
Copy link
Collaborator

High Level Overview of Change

Context of Change

Type of Change

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • Refactor (non-breaking change that only restructures code)
  • Tests (You added tests for code that already exists, or your new feature included in this PR)
  • Documentation Updates
  • Release

Did you update CHANGELOG.md?

  • Yes
  • No, this change does not impact library users

Test Plan

Copy link
Contributor

coderabbitai bot commented Dec 13, 2024

Walkthrough

The pull request updates the CHANGELOG.md file to include a new version entry for version 4.0.0, dated 2024-12-23. This version introduces support for Multi-Purpose Tokens (MPT), adds the include_deleted parameter in the ledger_entry request, removes support for Python 3.7, and modifies the retrieval of FeeSettings values. The previous version 3.0.0 is also documented, outlining significant changes and fixes.

Changes

File Change Summary
CHANGELOG.md - Added new version entry for 4.0.0 dated 2024-12-23.
- Included support for MPT amendment (XLS-33).
- Added include_deleted parameter in ledger_entry request.
- Removed Python 3.7 support, establishing Python 3.8 as the default.
- Modified retrieval of FeeSettings from the latest validated ledger.

Possibly related PRs

  • Update CHANGELOG.md #748: This PR updates the CHANGELOG.md file to include the include_deleted parameter in the ledger_entry request and notes the removal of Python 3.7 support, which directly relates to the changes made in the main PR.

Suggested reviewers

  • anissa-ripple
  • justinr1234

Poem

🐰 In the meadow where changes bloom,
A new version hops, dispelling gloom.
With tokens that multiply, and features anew,
Python's leap forward, a fresh start to pursue.
Changelog sings of progress and cheer,
As we bound into version four, oh dear! 🌼


📜 Recent review details

Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 6181d1c and 2940dc7.

📒 Files selected for processing (1)
  • CHANGELOG.md (1 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
  • CHANGELOG.md

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 generate docstrings to generate docstrings for this PR. (Beta)
  • @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.

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 (4)
CHANGELOG.md (4)

Line range hint 13-15: Enhance documentation for new features

Consider the following improvements:

  1. Add a link to the XLS-33 specification for the MPT amendment
  2. Provide a brief explanation of the include_deleted parameter's purpose and usage in the ledger_entry request

Example:

### Added
- Support for the Multi-Purpose Tokens (MPT) amendment ([XLS-33](https://github.com/XRPLF/XRPL-Standards/discussions/XLS-33))
- Add `include_deleted` to ledger_entry request (allows retrieval of deleted ledger entries)

Line range hint 17-18: Add migration guidance for Python 3.7 users

The breaking change removing Python 3.7 support should include:

  1. Migration steps for users on Python 3.7
  2. Specific dependency conflicts that necessitated this change
  3. Minimum required version of Python 3.8

Example:

### BREAKING CHANGE:
- Remove Python 3.7 support to fix dependency installation and use 3.8 as new default.
+ - Remove Python 3.7 support and require Python 3.8+ due to dependency conflicts with library X.
+   - If you're using Python 3.7, upgrade to Python 3.8.0 or later
+   - Update your CI/CD pipelines and development environments accordingly
+   - Verify compatibility with your existing dependencies

Line range hint 20-21: Clarify impact of FeeSettings changes

The fix for FeeSettings values should include:

  1. The impact on existing applications that might rely on the 10 drops default
  2. Whether this change affects transaction fee calculation
  3. Any required updates to application configurations

Example:

### Fixed
- Grab the FeeSettings values from the latest validated ledger. Remove hard-coded reference to 10 drops as the reference transaction cost.
+ - Grab the FeeSettings values from the latest validated ledger instead of using hard-coded 10 drops as the reference transaction cost.
+   - This may affect transaction fee calculations in your application
+   - Update your fee estimation logic if you were relying on the 10 drops default
+   - Monitor your transaction costs as they may vary based on network conditions

8-8: Consider removing empty Unreleased section

The [Unreleased] section is empty. Consider either:

  1. Removing it if there are no unreleased changes, or
  2. Moving the 4.0.0 changes to this section if they haven't been released yet

This helps maintain a clean and accurate changelog.

📜 Review details

Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 864f7b9 and bff9931.

📒 Files selected for processing (1)
  • CHANGELOG.md (1 hunks)
🔇 Additional comments (1)
CHANGELOG.md (1)

10-11: Verify the release date

The release date is set to December 16, 2024, which is in the future. Please confirm if this is intentional or if it should be adjusted to the actual release date.

@ckeshava ckeshava merged commit bcc0311 into main Dec 21, 2024
22 checks passed
@ckeshava ckeshava deleted the 4.0.0-release branch December 21, 2024 01:43
@coderabbitai coderabbitai bot mentioned this pull request Jan 13, 2025
9 tasks
@coderabbitai coderabbitai bot mentioned this pull request Jan 30, 2025
9 tasks
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.

4 participants