Valkyrie icon indicating copy to clipboard operation
Valkyrie copied to clipboard

Create a config option for checking java version feature

Open WaitingIdly opened this issue 1 year ago • 2 comments

📝 Description

create a config option for the checking outdated Java version warning feature.

🎯 Goals

allow disabling the outdated Java warning for users who are aware of the situation and are unwilling or unable to update.

❌ Non Goals

changing the default behavior of warning the user that the Java version being used is outdated.

🚦 Testing

dev environment only, when the config is either enabled and disabled.

⏮️ Backwards Compatibility

the default option of the config option (true) maintains the same default behavior as prior to the introduction of this config option.

📚 Related Issues & Documents

resolves #63

🖼️ Screenshots/Recordings

N/A

📖 Added to documentation?

  • [ ] 📜 README.md
  • [ ] 📑 Documentation
  • [ ] 📓 Javadoc
  • [ ] 🍕 Comments
  • [x] 🙅 No documentation needed

Summary by CodeRabbit

  • New Features

    • Introduced a new configuration option to enable or disable Java version checks.
    • Added tooltips for better user understanding of the Java version check setting.
  • Bug Fixes

    • Conditional execution of the Java version check thread based on user configuration to improve performance.

WaitingIdly avatar Sep 29 '24 10:09 WaitingIdly

Walkthrough

The changes introduce a new configuration option in the Valkyrie application that allows users to disable the Java version check at startup. A boolean variable, javaVersionCheck, is added to the configuration, which controls whether the check is executed. The implementation ensures that the check is only performed if this setting is enabled. Additionally, new localization entries are created to support this configuration option.

Changes

File Change Summary
src/main/java/dev/redstudio/valkyrie/Valkyrie.java Added a conditional check for executing the Java version check based on the javaVersionCheck property.
src/main/java/dev/redstudio/valkyrie/config/ValkyrieConfig.java Introduced a new boolean variable javaVersionCheck in GeneralConfig, initialized to true.
src/main/resources/assets/valkyrie/lang/en_us.lang Added two new localization entries for the Java version check configuration and its tooltip description.

Assessment against linked issues

Objective Addressed Explanation
Option to disable startup Java version check (#63)

🐰 In the meadow where bunnies hop,
A new config makes the Java check stop.
With a flick of a switch, it's easy to see,
No more pop-ups for you or for me!
So let's celebrate this change with glee,
Hooray for options, as happy as can be! 🌼


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.

coderabbitai[bot] avatar Sep 29 '24 10:09 coderabbitai[bot]

bump

HowardZHY avatar Apr 13 '25 12:04 HowardZHY