gradle implementation for the Ark plugin
Relate issue #73 This PR provides the implementation for packaging the Ark plugin in a Gradle environment.
Summary by CodeRabbit
-
New Features
- Introduced
ArkPluginCopyActionfor streamlined JAR file creation from processing streams. - Enhanced handling for directory entries and files in the "lib" directory during JAR packaging.
- Introduced
-
Tests
- Added
ArkPluginExtensionTestto validate the functionality and properties of theArkPluginExtensionclass.
- Added
Walkthrough
The changes introduce the ArkPluginCopyAction class, which implements the CopyAction interface for creating JAR files from a processing stream of files. This class includes methods for handling file and directory entries, specifically addressing shade files and files in the "lib" directory. Additionally, a new test class ArkPluginExtensionTest is added to validate the properties and behaviors of the ArkPluginExtension class, ensuring that the plugin functions as expected. A new build.gradle file sets up the Gradle build configuration, and modifications to .gitignore prevent version control of Gradle-related files.
Changes
| File | Change Summary |
|---|---|
.../ArkPluginCopyAction.java |
Introduced ArkPluginCopyAction class implementing CopyAction, facilitating JAR file creation from a processing stream. Added methods for processing files and directories, handling shade files, and managing JAR entry properties. |
.../ArkPluginExtension.java |
Added ArkPluginExtension abstract class for configuring Gradle plugins, defining properties and methods for plugin configuration. |
.../ArkPluginExtensionTest.java |
Added ArkPluginExtensionTest class containing unit tests for ArkPluginExtension, verifying default values and setter methods. |
.gitignore |
Updated to include entries for .gradle/, build/, gradle/, gradlew, and gradlew.bat to ignore Gradle-related files. |
.../build.gradle |
Introduced new build.gradle file for Gradle build configuration, applying necessary plugins and defining dependencies and publication settings. |
Poem
🐇 In the garden of code, new actions bloom,
JARs take shape, dispelling the gloom.
With files and streams, they dance in delight,
Ark's magic unfolds, a wondrous sight!
So hop along, let the plugins play,
In the world of Gradle, they brighten the day! 🌼
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?
🪧 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
@coderabbitaiin 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
@coderabbitaiin 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 pauseto pause the reviews on a PR.@coderabbitai resumeto resume the paused reviews.@coderabbitai reviewto trigger an incremental review. This is useful when automatic reviews are disabled for the repository.@coderabbitai full reviewto do a full review from scratch and review all the files again.@coderabbitai summaryto regenerate the summary of the PR.@coderabbitai resolveresolve all the CodeRabbit review comments.@coderabbitai configurationto show the current CodeRabbit configuration for the repository.@coderabbitai helpto get help.
Other keywords and placeholders
- Add
@coderabbitai ignoreanywhere in the PR description to prevent this PR from being reviewed. - Add
@coderabbitai summaryto generate the high-level summary at a specific location in the PR description. - Add
@coderabbitaianywhere in the PR title to generate the title automatically.
CodeRabbit Configuration File (.coderabbit.yaml)
- You can programmatically configure CodeRabbit by adding a
.coderabbit.yamlfile 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.
Codecov Report
All modified and coverable lines are covered by tests :white_check_mark:
Project coverage is 78.36%. Comparing base (
f3b88fc) to head (33850a6). Report is 1 commits behind head on master.
Additional details and impacted files
@@ Coverage Diff @@
## master #1012 +/- ##
============================================
+ Coverage 78.21% 78.36% +0.14%
Complexity 874 874
============================================
Files 171 171
Lines 7052 7052
Branches 1036 1036
============================================
+ Hits 5516 5526 +10
+ Misses 1005 994 -11
- Partials 531 532 +1
:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.