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

Basic setup for Java 21 #139

Merged
merged 1 commit into from
Aug 19, 2024
Merged

Basic setup for Java 21 #139

merged 1 commit into from
Aug 19, 2024

Conversation

jodastephen
Copy link
Member

@jodastephen jodastephen commented Aug 19, 2024

  • Adjust code so the symbol for currency XXX remains as XXX

Summary by CodeRabbit

  • New Features

    • Introduced version 2.0.0-RC1 with compatibility for Java SE 21 or later.
  • Documentation

    • Updated README and site documentation to clarify version compatibility and dependency requirements for Joda-Money.
  • Bug Fixes

    • Enhanced compatibility with modern Java versions and streamlined build configurations.

* Adjust code so the symbol for currency XXX remains as XXX
Copy link

coderabbitai bot commented Aug 19, 2024

Walkthrough

Walkthrough

The overall changes involve updating the Java compatibility of the Joda-Money library and its associated configuration files. The Java version has been upgraded from 11 to 21 in the build process, aligning the library with modern standards. Additionally, version compatibility details and dependency information in the documentation have been clarified, ensuring users understand the implications of using different versions.

Changes

File Change Summary
.github/workflows/build.yml Updated Java version from 11 to 21 in GitHub Actions workflow for improved performance and features.
README.md Clarified compatibility of Joda-Money versions with Java SE; refined dependency section indicating no mandatory runtime dependencies.
pom.xml Upgraded Joda-Money version to 2.0.0-RC1-SNAPSHOT; enforced Maven version 3.8.0 and Java 21+; streamlined compiler configuration for Java 21.
src/changes/changes.xml Added new release entry for version 2.0.0-RC1, highlighting major updates based on Java SE 21 while maintaining previous compatibility.
src/site/markdown/index.md Enhanced documentation on version compatibility with Java SE and clarified dependency details.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant Joda-Money
    participant GitHub Actions

    User->>GitHub Actions: Push code
    GitHub Actions->>Joda-Money: Build with Java 21
    Joda-Money->>GitHub Actions: Return build status
    GitHub Actions->>User: Notify build result
Loading

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

@jodastephen
Copy link
Member Author

@coderabbitai review

Copy link

coderabbitai bot commented Aug 19, 2024

Actions performed

Review triggered.

Note: CodeRabbit is an incremental review system and does not re-review already reviewed commits. This command is applicable only when automatic reviews are paused.

Copy link

@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

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between cdca28d and e3b3780.

Files selected for processing (5)
  • .github/workflows/build.yml (1 hunks)
  • README.md (2 hunks)
  • pom.xml (7 hunks)
  • src/changes/changes.xml (1 hunks)
  • src/site/markdown/index.md (1 hunks)
Files skipped from review due to trivial changes (1)
  • .github/workflows/build.yml
Additional comments not posted (9)
README.md (1)

53-61: Clarification on version compatibility and dependencies is well done.

The updates to the version compatibility and dependency information enhance clarity for users. These changes clearly communicate the requirements for different versions of the library.

src/site/markdown/index.md (1)

73-79: Consistency in documentation updates is appreciated.

The changes maintain consistency with the README.md updates, ensuring that users receive the same information across different documentation sources.

src/changes/changes.xml (1)

11-15: Addition of new release entry is clear and informative.

The new release entry for version 2.0.0-RC1 effectively communicates the major changes and compatibility with Java SE 21.

pom.xml (6)

12-13: Version and description updates align with Java 21 compatibility.

The version and description updates reflect the project's alignment with Java 21, ensuring users are aware of the new compatibility requirements.


Line range hint 103-119: Enforcement of Maven and Java versions is a good practice.

Updating the Maven Enforcer Plugin to require Maven 3.8.0 and Java 21 ensures that the build environment is consistent with the project's requirements.


202-204: Javadoc configuration updated for Java 21.

The Javadoc plugin configuration now uses Java 21, aligning documentation generation with the latest language features.


554-554: Surefire report configuration remains consistent with the new Java version.

The Surefire report plugin configuration is updated to reflect Java 21, ensuring test reports are generated correctly.


808-809: Compiler properties updated for Java 21.

The Maven compiler plugin properties now target Java 21, streamlining the build process for the latest Java version.


818-818: Checkstyle plugin version update is beneficial.

Updating the Checkstyle plugin to version 10.17.0 may introduce new rules and improvements, enhancing code quality checks.

@jodastephen jodastephen merged commit 0f79872 into v2.x Aug 19, 2024
3 checks passed
@jodastephen jodastephen deleted the java21 branch August 19, 2024 20:36
jodastephen added a commit that referenced this pull request Aug 25, 2024
* Adjust code so the symbol for currency XXX remains as XXX
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Development

Successfully merging this pull request may close these issues.

1 participant