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

feat: introduce the PluginOptions #4835

Merged
merged 2 commits into from
Oct 24, 2024
Merged

Conversation

WenyXu
Copy link
Member

@WenyXu WenyXu commented Oct 15, 2024

I hereby agree to the terms of the GreptimeDB CLA.

Refer to a related PR or issue link (optional)

What's changed and what's your intention?

introduce the PluginOptions

Checklist

  • I have written the necessary rustdoc comments.
  • I have added the necessary unit tests and integration tests.
  • This PR requires documentation updates.

@WenyXu WenyXu requested a review from a team as a code owner October 15, 2024 12:23
@github-actions github-actions bot added the docs-not-required This change does not impact docs. label Oct 15, 2024
Copy link
Collaborator

@fengjiachun fengjiachun left a comment

Choose a reason for hiding this comment

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

LGTM

@WenyXu WenyXu marked this pull request as draft October 15, 2024 12:46
@waynexia
Copy link
Member

Can we add something like PluginConfig in the config struct? It may look like

[[plugin.a]]
a1 = "xxx"
a2 = "xxx"

[[plugin.b]]
b1 = "xxx"
b2 = "xxx"

So every plugin can register and parse their options programly. And we won't duplicate the parsing step of config structs twice.

Copy link

codecov bot commented Oct 15, 2024

Codecov Report

Attention: Patch coverage is 43.75000% with 9 lines in your changes missing coverage. Please review.

Project coverage is 83.92%. Comparing base (6d503b0) to head (735deb4).
Report is 7 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff             @@
##             main    #4835      +/-   ##
==========================================
- Coverage   84.25%   83.92%   -0.33%     
==========================================
  Files        1129     1135       +6     
  Lines      208474   209496    +1022     
==========================================
+ Hits       175653   175828     +175     
- Misses      32821    33668     +847     

Copy link
Contributor

coderabbitai bot commented Oct 24, 2024

Important

Review skipped

Auto reviews are disabled on this repository.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.


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.

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.

@WenyXu WenyXu marked this pull request as ready for review October 24, 2024 06:19
@WenyXu WenyXu requested review from zyy17 and waynexia October 24, 2024 06:19
@WenyXu WenyXu changed the title feat: inject CmdContext into plugins feat: introduce the PluginOptions Oct 24, 2024
@WenyXu WenyXu enabled auto-merge October 24, 2024 08:16
@WenyXu WenyXu added this pull request to the merge queue Oct 24, 2024
@WenyXu WenyXu removed this pull request from the merge queue due to a manual request Oct 24, 2024
@WenyXu WenyXu added this pull request to the merge queue Oct 24, 2024
Merged via the queue into GreptimeTeam:main with commit 8b307e4 Oct 24, 2024
33 checks passed
@WenyXu WenyXu deleted the feat/cmd-context branch October 24, 2024 12:20
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs-not-required This change does not impact docs.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants