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

modify rules.txt to bootstrap.properties #48

Merged
merged 1 commit into from
Sep 18, 2024
Merged

modify rules.txt to bootstrap.properties #48

merged 1 commit into from
Sep 18, 2024

Conversation

lvjing2
Copy link
Contributor

@lvjing2 lvjing2 commented Sep 18, 2024

Summary by CodeRabbit

Release Notes

  • New Features

    • Introduced bootstrap.properties files for various modules to manage exclusions of artifact and group IDs, optimizing dependency management.
  • Bug Fixes

    • Removed outdated rules.txt files that previously defined exclusions, which could lead to potential conflicts or unnecessary dependencies being included in builds.
  • Documentation

    • Updated README files to clarify configuration file locations for dependency management, enhancing usability and understanding of the module slimming process.

Copy link

coderabbitai bot commented Sep 18, 2024

Walkthrough

The changes primarily involve the removal of the <packExcludesConfig> element from various pom.xml files and the deletion of rules.txt files across multiple modules. This modification suggests a shift in how dependencies are managed and packaged within the Spring Boot applications, potentially allowing previously excluded files and libraries to be included in the final artifacts.

Changes

File(s) Change Summary
sofaboot-samples/dynamic-stock/biz1/pom.xml Removed <packExcludesConfig>rules.txt</packExcludesConfig>.
sofaboot4-samples/dynamic-stock/biz1/pom.xml Removed <packExcludesConfig>rules.txt</packExcludesConfig>.
springboot-samples/cache/ehcache/README-zh_CN.md Updated configuration method for module slimming from rules.txt to bootstrap.properties/yml.
springboot-samples/cache/ehcache/README.md Updated configuration method for module slimming from rules.txt to bootstrap.properties/yml.
springboot-samples/cache/ehcache/biz1-ehcache/conf/ark/bootstrap.properties Added exclusions for artifact IDs and group IDs.
springboot-samples/cache/ehcache/biz1-ehcache/conf/ark/rules.txt Removed exclusion rules for various artifact IDs and group IDs.
springboot-samples/cache/ehcache/biz1-ehcache/pom.xml Removed <packExcludesConfig>rules.txt</packExcludesConfig>.
springboot-samples/cache/ehcache/biz2-ehcache/conf/ark/bootstrap.properties Added exclusions for artifact IDs and group IDs.
springboot-samples/cache/ehcache/biz2-ehcache/conf/ark/rules.txt Removed exclusion rules for various artifact IDs and group IDs.
springboot-samples/cache/ehcache/biz2-ehcache/pom.xml Removed <packExcludesConfig>rules.txt</packExcludesConfig>.
springboot-samples/cache/redis/README.md Updated configuration file paths for module slimming from rules.txt to bootstrap.properties/yml.
springboot-samples/config/apollo/README-zh_CN.md Updated configuration file location for excludeGroupIds from rules.txt to bootstrap.properties/yml.
springboot-samples/config/apollo/README.md Updated configuration file location for excludeGroupIds from rules.txt to bootstrap.properties/yml.
springboot-samples/config/apollo/biz1-apollo/conf/ark/bootstrap.properties Added exclusions for artifact IDs and group IDs.
springboot-samples/config/apollo/biz1-apollo/conf/ark/rules.txt Removed exclusion rules for various artifact and group IDs.
springboot-samples/config/apollo/biz1-apollo/pom.xml Removed <packExcludesConfig>rules.txt</packExcludesConfig>.
springboot-samples/config/apollo/biz2-apollo/conf/ark/bootstrap.properties Added exclusions for artifact IDs and group IDs.
springboot-samples/config/apollo/biz2-apollo/conf/ark/rules.txt Removed exclusion rules for various artifact and group IDs.
springboot-samples/config/apollo/biz2-apollo/pom.xml Removed <packExcludesConfig>rules.txt</packExcludesConfig>.
springboot-samples/config/nacos/biz1-nacos/conf/ark/bootstrap.properties Added exclusions for artifact IDs and group IDs.
springboot-samples/config/nacos/biz1-nacos/conf/ark/rules.txt Removed exclusion rules for various artifact and group IDs.
springboot-samples/config/nacos/biz1-nacos/pom.xml Removed <packExcludesConfig>rules.txt</packExcludesConfig>.
springboot-samples/config/nacos/biz2-nacos/conf/ark/bootstrap.properties Added exclusions for artifact IDs and group IDs.
springboot-samples/config/nacos/biz2-nacos/conf/ark/rules.txt Removed exclusion rules for various artifact and group IDs.
springboot-samples/config/nacos/biz2-nacos/pom.xml Removed <packExcludesConfig>rules.txt</packExcludesConfig>.
springboot-samples/service/base/base-bootstrap/src/main/java/com/alipay/sofa/base/rest/SampleController.java Cosmetic formatting changes.
springboot-samples/slimming/README-zh_CN.md Updated documentation regarding module slimming configuration file paths.
springboot-samples/slimming/README.md Updated documentation regarding module slimming configuration file paths.
springboot-samples/slimming/log4j2/biz1/conf/ark/bootstrap.properties Added exclusions for artifact IDs and group IDs.
springboot-samples/slimming/log4j2/biz1/conf/ark/rules.txt Removed exclusion rules for various artifact IDs and group IDs.
springboot-samples/slimming/log4j2/biz1/pom.xml Removed <packExcludesConfig>rules.txt</packExcludesConfig>.
springboot-samples/springcloud/gateway/README-zh_CN.md Removed <packExcludesConfig>rules.txt</packExcludesConfig>.
springboot-samples/springcloud/gateway/README.md Removed <packExcludesConfig>rules.txt</packExcludesConfig>.
springboot-samples/springcloud/gateway/biz1-cloud-gateway/conf/ark/bootstrap.properties Added exclusions for artifact IDs and group IDs.
springboot-samples/springcloud/gateway/biz1-cloud-gateway/conf/ark/rules.txt Removed exclusion rules for various artifact and group IDs.
springboot-samples/springcloud/gateway/biz1-cloud-gateway/pom.xml Removed <packExcludesConfig>rules.txt</packExcludesConfig>.
springboot-samples/springcloud/gateway/biz2-cloud-gateway/conf/ark/bootstrap.properties Added exclusions for artifact IDs and group IDs.
springboot-samples/springcloud/gateway/biz2-cloud-gateway/conf/ark/rules.txt Removed exclusion rules for various artifact and group IDs.
springboot-samples/springcloud/gateway/biz2-cloud-gateway/pom.xml Removed <packExcludesConfig>rules.txt</packExcludesConfig>.
springboot-samples/web/tomcat/biz1-web-single-host/conf/ark/bootstrap.properties Added exclusions for artifact IDs and group IDs.
springboot-samples/web/tomcat/biz1-web-single-host/conf/ark/rules.txt Removed exclusion rules for various artifact and group IDs.
springboot-samples/web/tomcat/biz1-web-single-host/pom.xml Removed <packExcludesConfig>rules.txt</packExcludesConfig>.
springboot1-samples/web/tomcat/biz1/conf/ark/bootstrap.properties Added exclusions for artifact IDs and group IDs.
springboot1-samples/web/tomcat/biz1/conf/ark/rules.txt Removed exclusion rules for various artifact and group IDs.
springboot1-samples/web/tomcat/biz1/pom.xml Removed <packExcludesConfig>rules.txt</packExcludesConfig>.
springboot1-samples/web/tomcat/biz2/conf/ark/bootstrap.properties Added exclusions for artifact IDs and group IDs.
springboot1-samples/web/tomcat/biz2/conf/ark/rules.txt Removed exclusion rules for various artifact and group IDs.
springboot1-samples/web/tomcat/biz2/pom.xml Removed <packExcludesConfig>rules.txt</packExcludesConfig>.

Possibly related PRs

  • fix tomcat base package #44: The changes in this PR involve the removal of the <packExcludesConfig> element from the pom.xml file, which is directly related to the removal of the same element in the main PR. Both PRs affect how files are packaged, potentially altering the contents of the final artifact.

Suggested reviewers

  • No specific reviewers suggested.

Poem

🐇 In the garden where changes bloom,
Files once hidden now find room.
Exclusions gone, a fresh new start,
Packaging joyfully, a work of art!
With every hop, we celebrate,
A cleaner build, oh, isn't it great! 🌼


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 generate interesting stats about this repository and render them as a table.
    -- @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.

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

Outside diff range and nitpick comments (7)
springboot-samples/cache/ehcache/biz2-ehcache/conf/ark/bootstrap.properties (1)

1-15: LGTM! The configuration looks good.

The bootstrap.properties file correctly specifies the artifact IDs and group IDs to be excluded from the dependency management. This can help optimize the build process by reducing the application size and avoiding potential conflicts.

A few additional suggestions:

  • Consider adding comments to explain the purpose of each exclusion or grouping related exclusions together for better readability.
  • Ensure that all required dependencies are still included after applying these exclusions.
  • Regularly review and update the exclusion list as the project evolves to keep it in sync with the current dependencies.
springboot-samples/slimming/log4j2/biz1/conf/ark/bootstrap.properties (1)

1-14: LGTM! The exclusion configuration looks good.

The excludeArtifactIds and excludeGroupIds properties are used effectively to exclude a wide range of unnecessary or potentially conflicting libraries from the build process. This can help optimize the application's dependencies, reduce its footprint, and improve performance.

A few additional considerations:

  1. Ensure that the exclusions do not accidentally remove any necessary dependencies. Thoroughly test the application to confirm that it functions as expected with the slimmed-down dependencies.

  2. Consider organizing the exclusions into logical groups or adding comments to improve readability and maintainability. For example, you could group exclusions by framework or purpose.

  3. Regularly review and update the exclusions as the application and its dependencies evolve over time. New versions of libraries might address issues that previously required exclusion, or new dependencies might introduce conflicts that need to be excluded.

  4. If the application is part of a larger system, consider aligning the exclusions across projects to maintain consistency and avoid unexpected behavior due to differences in dependencies.

By carefully managing the application's dependencies through these exclusions, you can create a more efficient, stable, and maintainable system.

springboot-samples/config/nacos/biz2-nacos/conf/ark/bootstrap.properties (1)

1-15: Exclusions can optimize the build, but ensure all required dependencies are included.

The excludeArtifactIds and excludeGroupIds properties are used to exclude a wide range of libraries and frameworks from the application's dependency management. This approach can offer several benefits:

  • Optimizing the build process by preventing the inclusion of unnecessary libraries.
  • Reducing the final artifact size and improving application performance.
  • Mitigating potential issues arising from transitive dependencies.

However, it's crucial to verify that all required dependencies are still included after applying these exclusions. Accidentally excluding a necessary dependency could lead to runtime errors or unexpected behavior.

Consider adding comments to explain the rationale behind the chosen exclusions. This can help maintain the configuration and make it easier for other developers to understand the purpose of each exclusion.

springboot-samples/slimming/README-zh_CN.md (1)

11-11: LGTM! The changes enhance the clarity of the documentation.

The updated instructions provide additional options for the module slimming configuration file format, making it easier for users to understand and configure the module slimming process.

Please fix the following grammatical issue:

-为了更好的使用模块自动瘦身功能
+为了更好地使用模块自动瘦身功能

The adverb "更好" should be followed by "地" instead of "的" when modifying the verb "使用".

Tools
LanguageTool

[uncategorized] ~11-~11: 动词的修饰一般为‘形容词(副词)+地+动词’。您的意思是否是:好"地"使用
Context: ...基座的包,这样打出的 ark-biz jar 会更加轻量。在复杂应用中,为了更好的使用模块自动瘦身功能,需要在模块瘦身配置 (根目录 /conf/ark/boot...

(wb4)

springboot-samples/slimming/README.md (1)

9-9: Approve the changes with writing suggestions.

The updated instructions provide clear recommendations for slimming the ark biz jar by using bootstrap.properties or bootstrap.yml for the slimming configuration. This aligns with common practices in SpringBoot applications and can help users optimize their application.

To further enhance the readability and professionalism of the documentation, consider the following writing suggestions:

  • Replace the informal word "biz" with "business" or "application".
  • Replace "very small" with a more descriptive alternative, such as "significantly reduced in size".
  • Use the gerund form with "recommend", i.e., "We recommend excluding those dependencies..."

Apply this diff to incorporate the writing suggestions:

-how to slim ark biz jar: delegate the framework, middleware and other common dependencies to base, and reuse the dependencies in base, so that the ark-biz jar will be very small. We recommend to exclude those dependencies in module by slimming configuration (conf/ark/bootstrap.properties or conf/ark/bootstrap.yml).
+How to slim the ark application jar: Delegate the framework, middleware, and other common dependencies to the base, and reuse the dependencies in the base, so that the ark application jar will be significantly reduced in size. We recommend excluding those dependencies in the module by using the slimming configuration (conf/ark/bootstrap.properties or conf/ark/bootstrap.yml).
Tools
LanguageTool

[style] ~9-~9: The word ‘biz’ is informal. Consider replacing it.
Context: ...ndencies ## precautions how to slim ark biz jar: delegate the framework, middleware...

(BIZ)


[style] ~9-~9: As an alternative to the over-used intensifier ‘very’, consider replacing this phrase.
Context: ...n base, so that the ark-biz jar will be very small. We recommend to exclude those dependen...

(EN_WEAK_ADJECTIVE)


[grammar] ~9-~9: The verb ‘recommend’ is used with the gerund form.
Context: ... the ark-biz jar will be very small. We recommend to exclude those dependencies in module by slimmin...

(ADMIT_ENJOY_VB)

springboot-samples/cache/ehcache/README.md (1)

85-85: Approve the configuration change and clarification.

The change in configuration file from rules.txt to conf/ark/bootstrap.properties or conf/ark/bootstrap.yml for managing the automatic slimming of the module looks good. The note clearly explains that the ehcache dependency will still be automatically delegated to the base for loading, maintaining the functionality.

Also, the reminder about changing the web context path for different business modules to ensure coexistence of multiple web applications on a single Tomcat host is helpful.

Consider updating the preposition in this sentence for better clarity:

-so that multiple web applications can be successfully installed in a tomcat host.
+so that multiple web applications can be successfully installed on a tomcat host.
Tools
LanguageTool

[style] ~85-~85: The word ‘biz’ is informal. Consider replacing it.
Context: ...hange the web context path of different biz to different values, so that multiple w...

(BIZ)


[uncategorized] ~85-~85: The preposition “on” seems more likely in this position than the preposition “in”.
Context: ...lications can be successfully installed in a tomcat host. ### biz2 same as biz1 ...

(AI_EN_LECTOR_REPLACEMENT_PREPOSITION_IN_ON)

springboot-samples/cache/redis/README.md (1)

65-65: Approve the configuration file path change.

The change from rules.txt to conf/ark/bootstrap.properties or conf/ark/bootstrap.yml for automatic module slimming looks good. It should enhance the configuration management approach.

Consider replacing the informal word "biz" with "business application" to use more formal language:

-Note that here by introducing conf/ark/bootstrap.properties or conf/ark/bootstrap.yml to complete the automatic slimming of the module, including the dependency of ehcache will also be automatically delegated to the base for loading. Also, you need to change the web context path of different biz to different values, so that multiple web applications can be successfully installed in a tomcat host.
+Note that here by introducing conf/ark/bootstrap.properties or conf/ark/bootstrap.yml to complete the automatic slimming of the module, including the dependency of ehcache will also be automatically delegated to the base for loading. Also, you need to change the web context path of different business applications to different values, so that multiple web applications can be successfully installed in a tomcat host.
Tools
LanguageTool

[style] ~65-~65: You have already used this phrasing in nearby sentences. Consider replacing it to add variety to your writing.
Context: ...ated to the base for loading. Also, you need to change the web context path of differen...

(REP_NEED_TO_VB)


[style] ~65-~65: The word ‘biz’ is informal. Consider replacing it.
Context: ...hange the web context path of different biz to different values, so that multiple w...

(BIZ)

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 909e885 and a67420d.

Files selected for processing (61)
  • sofaboot-samples/dynamic-stock/biz1/pom.xml (0 hunks)
  • sofaboot4-samples/dynamic-stock/biz1/pom.xml (0 hunks)
  • springboot-samples/cache/ehcache/README-zh_CN.md (1 hunks)
  • springboot-samples/cache/ehcache/README.md (1 hunks)
  • springboot-samples/cache/ehcache/biz1-ehcache/conf/ark/bootstrap.properties (1 hunks)
  • springboot-samples/cache/ehcache/biz1-ehcache/conf/ark/rules.txt (0 hunks)
  • springboot-samples/cache/ehcache/biz1-ehcache/pom.xml (0 hunks)
  • springboot-samples/cache/ehcache/biz2-ehcache/conf/ark/bootstrap.properties (1 hunks)
  • springboot-samples/cache/ehcache/biz2-ehcache/conf/ark/rules.txt (0 hunks)
  • springboot-samples/cache/ehcache/biz2-ehcache/pom.xml (0 hunks)
  • springboot-samples/cache/redis/README.md (1 hunks)
  • springboot-samples/config/apollo/README-zh_CN.md (1 hunks)
  • springboot-samples/config/apollo/README.md (1 hunks)
  • springboot-samples/config/apollo/biz1-apollo/conf/ark/bootstrap.properties (1 hunks)
  • springboot-samples/config/apollo/biz1-apollo/conf/ark/rules.txt (0 hunks)
  • springboot-samples/config/apollo/biz1-apollo/pom.xml (0 hunks)
  • springboot-samples/config/apollo/biz2-apollo/conf/ark/bootstrap.properties (1 hunks)
  • springboot-samples/config/apollo/biz2-apollo/conf/ark/rules.txt (0 hunks)
  • springboot-samples/config/apollo/biz2-apollo/pom.xml (0 hunks)
  • springboot-samples/config/nacos/biz1-nacos/conf/ark/bootstrap.properties (1 hunks)
  • springboot-samples/config/nacos/biz1-nacos/conf/ark/rules.txt (0 hunks)
  • springboot-samples/config/nacos/biz1-nacos/pom.xml (0 hunks)
  • springboot-samples/config/nacos/biz2-nacos/conf/ark/bootstrap.properties (1 hunks)
  • springboot-samples/config/nacos/biz2-nacos/conf/ark/rules.txt (0 hunks)
  • springboot-samples/config/nacos/biz2-nacos/pom.xml (0 hunks)
  • springboot-samples/service/base/base-bootstrap/src/main/java/com/alipay/sofa/base/rest/SampleController.java (2 hunks)
  • springboot-samples/slimming/README-zh_CN.md (1 hunks)
  • springboot-samples/slimming/README.md (1 hunks)
  • springboot-samples/slimming/log4j2/biz1/conf/ark/bootstrap.properties (1 hunks)
  • springboot-samples/slimming/log4j2/biz1/conf/ark/rules.txt (0 hunks)
  • springboot-samples/slimming/log4j2/biz1/pom.xml (0 hunks)
  • springboot-samples/springcloud/gateway/README-zh_CN.md (0 hunks)
  • springboot-samples/springcloud/gateway/README.md (0 hunks)
  • springboot-samples/springcloud/gateway/biz1-cloud-gateway/conf/ark/bootstrap.properties (1 hunks)
  • springboot-samples/springcloud/gateway/biz1-cloud-gateway/conf/ark/rules.txt (0 hunks)
  • springboot-samples/springcloud/gateway/biz1-cloud-gateway/pom.xml (0 hunks)
  • springboot-samples/springcloud/gateway/biz2-cloud-gateway/conf/ark/bootstrap.properties (1 hunks)
  • springboot-samples/springcloud/gateway/biz2-cloud-gateway/conf/ark/rules.txt (0 hunks)
  • springboot-samples/springcloud/gateway/biz2-cloud-gateway/pom.xml (0 hunks)
  • springboot-samples/web/tomcat/biz1-web-single-host/conf/ark/bootstrap.properties (1 hunks)
  • springboot-samples/web/tomcat/biz1-web-single-host/conf/ark/rules.txt (0 hunks)
  • springboot-samples/web/tomcat/biz1-web-single-host/pom.xml (0 hunks)
  • springboot-samples/web/tomcat/biz2-web-single-host/conf/ark/bootstrap.properties (1 hunks)
  • springboot1-samples/web/tomcat/biz1/conf/ark/bootstrap.properties (1 hunks)
  • springboot1-samples/web/tomcat/biz1/conf/ark/rules.txt (0 hunks)
  • springboot1-samples/web/tomcat/biz1/pom.xml (0 hunks)
  • springboot1-samples/web/tomcat/biz2/conf/ark/bootstrap.properties (1 hunks)
  • springboot3-samples/config/apollo/README-zh_CN.md (1 hunks)
  • springboot3-samples/config/apollo/README.md (1 hunks)
  • springboot3-samples/config/apollo/biz1/conf/ark/bootstrap.properties (1 hunks)
  • springboot3-samples/config/apollo/biz1/conf/ark/rules.txt (0 hunks)
  • springboot3-samples/config/apollo/biz1/pom.xml (0 hunks)
  • springboot3-samples/config/apollo/biz2/conf/ark/bootstrap.properties (1 hunks)
  • springboot3-samples/config/apollo/biz2/conf/ark/rules.txt (0 hunks)
  • springboot3-samples/config/apollo/biz2/pom.xml (0 hunks)
  • springboot3-samples/config/nacos/biz1/conf/ark/bootstrap.properties (1 hunks)
  • springboot3-samples/config/nacos/biz1/conf/ark/rules.txt (0 hunks)
  • springboot3-samples/config/nacos/biz1/pom.xml (0 hunks)
  • springboot3-samples/config/nacos/biz2/conf/ark/bootstrap.properties (1 hunks)
  • springboot3-samples/config/nacos/biz2/conf/ark/rules.txt (0 hunks)
  • springboot3-samples/config/nacos/biz2/pom.xml (0 hunks)
Files not reviewed due to no reviewable changes (34)
  • sofaboot-samples/dynamic-stock/biz1/pom.xml
  • sofaboot4-samples/dynamic-stock/biz1/pom.xml
  • springboot-samples/cache/ehcache/biz1-ehcache/conf/ark/rules.txt
  • springboot-samples/cache/ehcache/biz1-ehcache/pom.xml
  • springboot-samples/cache/ehcache/biz2-ehcache/conf/ark/rules.txt
  • springboot-samples/cache/ehcache/biz2-ehcache/pom.xml
  • springboot-samples/config/apollo/biz1-apollo/conf/ark/rules.txt
  • springboot-samples/config/apollo/biz1-apollo/pom.xml
  • springboot-samples/config/apollo/biz2-apollo/conf/ark/rules.txt
  • springboot-samples/config/apollo/biz2-apollo/pom.xml
  • springboot-samples/config/nacos/biz1-nacos/conf/ark/rules.txt
  • springboot-samples/config/nacos/biz1-nacos/pom.xml
  • springboot-samples/config/nacos/biz2-nacos/conf/ark/rules.txt
  • springboot-samples/config/nacos/biz2-nacos/pom.xml
  • springboot-samples/slimming/log4j2/biz1/conf/ark/rules.txt
  • springboot-samples/slimming/log4j2/biz1/pom.xml
  • springboot-samples/springcloud/gateway/README-zh_CN.md
  • springboot-samples/springcloud/gateway/README.md
  • springboot-samples/springcloud/gateway/biz1-cloud-gateway/conf/ark/rules.txt
  • springboot-samples/springcloud/gateway/biz1-cloud-gateway/pom.xml
  • springboot-samples/springcloud/gateway/biz2-cloud-gateway/conf/ark/rules.txt
  • springboot-samples/springcloud/gateway/biz2-cloud-gateway/pom.xml
  • springboot-samples/web/tomcat/biz1-web-single-host/conf/ark/rules.txt
  • springboot-samples/web/tomcat/biz1-web-single-host/pom.xml
  • springboot1-samples/web/tomcat/biz1/conf/ark/rules.txt
  • springboot1-samples/web/tomcat/biz1/pom.xml
  • springboot3-samples/config/apollo/biz1/conf/ark/rules.txt
  • springboot3-samples/config/apollo/biz1/pom.xml
  • springboot3-samples/config/apollo/biz2/conf/ark/rules.txt
  • springboot3-samples/config/apollo/biz2/pom.xml
  • springboot3-samples/config/nacos/biz1/conf/ark/rules.txt
  • springboot3-samples/config/nacos/biz1/pom.xml
  • springboot3-samples/config/nacos/biz2/conf/ark/rules.txt
  • springboot3-samples/config/nacos/biz2/pom.xml
Files skipped from review due to trivial changes (1)
  • springboot-samples/service/base/base-bootstrap/src/main/java/com/alipay/sofa/base/rest/SampleController.java
Additional context used
LanguageTool
springboot-samples/slimming/README-zh_CN.md

[uncategorized] ~11-~11: 动词的修饰一般为‘形容词(副词)+地+动词’。您的意思是否是:好"地"使用
Context: ...基座的包,这样打出的 ark-biz jar 会更加轻量。在复杂应用中,为了更好的使用模块自动瘦身功能,需要在模块瘦身配置 (根目录 /conf/ark/boot...

(wb4)

springboot-samples/slimming/README.md

[style] ~9-~9: The word ‘biz’ is informal. Consider replacing it.
Context: ...ndencies ## precautions how to slim ark biz jar: delegate the framework, middleware...

(BIZ)


[style] ~9-~9: As an alternative to the over-used intensifier ‘very’, consider replacing this phrase.
Context: ...n base, so that the ark-biz jar will be very small. We recommend to exclude those dependen...

(EN_WEAK_ADJECTIVE)


[grammar] ~9-~9: The verb ‘recommend’ is used with the gerund form.
Context: ... the ark-biz jar will be very small. We recommend to exclude those dependencies in module by slimmin...

(ADMIT_ENJOY_VB)

springboot-samples/cache/ehcache/README.md

[style] ~85-~85: The word ‘biz’ is informal. Consider replacing it.
Context: ...hange the web context path of different biz to different values, so that multiple w...

(BIZ)


[uncategorized] ~85-~85: The preposition “on” seems more likely in this position than the preposition “in”.
Context: ...lications can be successfully installed in a tomcat host. ### biz2 same as biz1 ...

(AI_EN_LECTOR_REPLACEMENT_PREPOSITION_IN_ON)

springboot-samples/cache/redis/README.md

[style] ~65-~65: You have already used this phrasing in nearby sentences. Consider replacing it to add variety to your writing.
Context: ...ated to the base for loading. Also, you need to change the web context path of differen...

(REP_NEED_TO_VB)


[style] ~65-~65: The word ‘biz’ is informal. Consider replacing it.
Context: ...hange the web context path of different biz to different values, so that multiple w...

(BIZ)

Additional comments not posted (19)
springboot-samples/web/tomcat/biz1-web-single-host/conf/ark/bootstrap.properties (1)

1-14: Looks good! The exclusion list is comprehensive and well-organized.

The bootstrap.properties file provides a thorough list of artifact IDs and group IDs to be excluded from the build process. This can help streamline the application, reduce potential conflicts, and improve overall performance.

A few points to consider:

  1. Ensure that the excluded dependencies are indeed unnecessary for the application's functionality. Double-check that no required dependencies are accidentally excluded.

  2. The use of wildcards in excludeGroupIds provides flexibility, but be cautious not to exclude unintended dependencies. Regularly review and update the exclusion list as the application evolves.

  3. Consider adding comments to explain the rationale behind specific exclusions, especially for less common libraries. This can help maintain the configuration's clarity and make it easier for other developers to understand the choices made.

Overall, the configuration looks solid and well-structured. Keep up the good work in managing the application's dependencies!

springboot-samples/web/tomcat/biz2-web-single-host/conf/ark/bootstrap.properties (1)

1-14: Comprehensive dependency exclusion configuration.

The bootstrap.properties file provides a comprehensive list of artifact and group IDs to be excluded from the build process. This configuration is crucial for managing dependencies and ensuring a clean and efficient project structure.

Key benefits of this configuration:

  • Avoids potential dependency conflicts by excluding unnecessary libraries.
  • Reduces the size of the final build by excluding unnecessary components.
  • Enhances performance by ensuring that only the necessary components are included.
  • Serves as a central point for dependency management, making it easier to maintain the project.

The exclusions cover a wide range of libraries, including:

  • Common Java libraries (e.g., commons-collections, commons-io, commons-lang)
  • Logging frameworks (e.g., log4j, ch.qos.logback)
  • Various third-party dependencies (e.g., com.google.guava, org.apache, org.springframework)

Overall, this configuration is well-structured and comprehensive, providing a solid foundation for dependency management in the Spring Boot application.

springboot-samples/cache/ehcache/biz1-ehcache/conf/ark/bootstrap.properties (1)

1-15: LGTM! The exclusion configuration looks good.

The bootstrap.properties file correctly defines the excludeArtifactIds and excludeGroupIds properties to exclude unnecessary dependencies from the application's build process. This can help optimize the application in several ways:

  • Reducing the application's footprint by excluding unnecessary libraries
  • Improving performance by avoiding the overhead of loading and managing unused dependencies
  • Preventing potential conflicts between different versions of the same library
  • Ensuring that only the necessary components are packaged, leading to a cleaner and more efficient deployment

The exclusions cover a comprehensive range of libraries, including common Java libraries, logging frameworks, and various third-party dependencies. The configuration is syntactically correct and follows the expected format for properties files.

Great job on defining these exclusions to streamline the application's dependency management!

springboot-samples/springcloud/gateway/biz1-cloud-gateway/conf/ark/bootstrap.properties (1)

1-12: Comprehensive dependency exclusion configuration for a cleaner and more maintainable codebase.

The introduction of the bootstrap.properties file with a comprehensive list of artifact IDs and group IDs to be excluded from the Spring Cloud Gateway application is a positive step towards better dependency management. This configuration aligns with best practices and offers several benefits:

  1. Reduced application footprint: By excluding unnecessary dependencies, the application can maintain a smaller footprint, leading to faster startup times and reduced memory consumption.

  2. Avoidance of potential version conflicts: Excluding specific versions of libraries helps to mitigate the risk of version conflicts and incompatibilities, ensuring a more stable and predictable runtime environment.

  3. Enhanced performance: Removing unnecessary dependencies can improve the application's overall performance by reducing the overhead associated with managing and loading unused libraries.

  4. Cleaner and more maintainable codebase: Focusing on the core functionalities of the application and excluding unnecessary dependencies promotes a cleaner and more maintainable codebase, making it easier to understand, debug, and evolve over time.

However, it is important to consider the following:

  1. Ensure necessary dependencies are still included: While excluding unnecessary dependencies is beneficial, it is crucial to ensure that the application still includes all the required dependencies for its proper functioning. Careful review and testing should be conducted to avoid unintended consequences.

  2. Regular review and update: As the application evolves and new features are added, the dependency exclusion configuration should be regularly reviewed and updated to ensure it remains relevant and effective.

Overall, the introduction of this configuration demonstrates a proactive approach to dependency management and sets a solid foundation for a more efficient and maintainable Spring Cloud Gateway application.

springboot-samples/springcloud/gateway/biz2-cloud-gateway/conf/ark/bootstrap.properties (1)

1-12: LGTM! The exclusion list is comprehensive and well-formatted.

The excludeArtifactIds and excludeGroupIds properties in the bootstrap.properties file provide a comprehensive list of artifact IDs and group IDs to be excluded from the dependency management process. This extensive exclusion list covers a wide range of libraries and frameworks, including common Java libraries, logging frameworks, and various utility libraries.

By defining these exclusions, the configuration aims to streamline the dependency resolution process, potentially reducing conflicts and improving the overall stability of the application. The exclusions are formatted as comma-separated values, allowing for easy modification and extension in the future.

This setup is particularly useful in environments where certain libraries may introduce compatibility issues or are deemed unnecessary for the application's functionality. However, it's important to ensure that the exclusions do not unintentionally remove essential dependencies that are required for the application to function properly.

Consider periodically reviewing the exclusion list to ensure it remains up-to-date and aligned with the application's requirements. Additionally, it's a good practice to document the rationale behind each exclusion to facilitate future maintenance and troubleshooting.

springboot1-samples/web/tomcat/biz1/conf/ark/bootstrap.properties (1)

1-17: Excellent work on defining the exclusions in the bootstrap.properties file!

The configuration is well-structured and covers a comprehensive list of artifact IDs and group IDs to be excluded from the build process. The use of wildcards in the excludeGroupIds property allows for flexible matching of group IDs, making the configuration adaptable to changing project requirements.

By defining these exclusions, you are effectively streamlining the dependency management process, potentially reducing the application's footprint and avoiding issues related to version conflicts or redundant libraries. This is particularly useful in enterprise environments where dependency management can become complex due to the integration of multiple libraries and frameworks.

The configuration is easy to read and maintain, with related exclusions grouped together. This will make it easier for other developers to understand and modify the exclusions as needed.

Overall, this configuration is a great addition to the project and will contribute to a more efficient and reliable build process.

springboot1-samples/web/tomcat/biz2/conf/ark/bootstrap.properties (1)

1-17: LGTM! The exclusions list is comprehensive and well-structured.

The bootstrap.properties file provides a clear and comprehensive list of artifact and group IDs to be excluded from dependency management. This approach can help streamline the application's dependencies, reduce potential conflicts or bloat, and optimize the build process.

A few additional suggestions for consideration:

  1. Ensure that the exclusions align with the project's overall dependency management strategy and do not inadvertently exclude any required dependencies.
  2. Consider adding comments to the file to provide additional context or rationale for the exclusions, which can be helpful for future maintainers.
  3. Regularly review and update the exclusions list as the project evolves to ensure that it remains relevant and effective.
springboot3-samples/config/nacos/biz1/conf/ark/bootstrap.properties (1)

1-14: Comprehensive exclusion list for optimizing the application's runtime environment.

The exclusion list covers a wide range of commonly used libraries and frameworks, which can help reduce conflicts and bloat in the application's dependency tree. This is particularly beneficial in microservices architectures, where minimizing the footprint of each service is often a priority.

The list is well-structured and organized, with related exclusions grouped together. The use of both specific artifact IDs and broader group IDs allows for fine-tuned control over the dependencies.

Please ensure that none of the excluded dependencies are actually required by the application, as this could lead to runtime errors. You can use the following script to search for references to the excluded artifacts and groups in the codebase:

If any of the excluded artifacts or groups are referenced in the codebase, please carefully review whether they are actually required and remove them from the exclusion list if necessary.

springboot3-samples/config/nacos/biz2/conf/ark/bootstrap.properties (1)

1-14: Comprehensive dependency exclusions for effective management.

The bootstrap.properties file provides a comprehensive list of artifact IDs and group IDs to be excluded from the dependency management process. This configuration is crucial for managing dependencies effectively in a Spring Boot application, particularly when integrating with Nacos for service discovery and configuration management.

The exclusions cover a wide range of libraries and frameworks, including:

  • Apache libraries (e.g., commons-collections, commons-httpclient, commons-io, commons-lang)
  • Google libraries (e.g., com.google.common*, com.google.gson*, com.google.guava*, com.google.inject*)
  • Other third-party dependencies (e.g., com.alibaba*, com.alipay*, com.fasterxml*, io.netty*, javax*, org.springframework*)

By defining these exclusions, the application can:

  • Avoid potential issues related to dependency conflicts
  • Reduce the size of the final build
  • Streamline the dependency resolution process

This file serves as a centralized configuration point for managing dependencies effectively, ensuring that only the required artifacts are included in the build.

springboot-samples/config/nacos/biz1-nacos/conf/ark/bootstrap.properties (1)

1-15: Comprehensive dependency exclusion configuration

The bootstrap.properties file provides a comprehensive list of artifact and group IDs to be excluded from dependency management. This configuration can help streamline the dependency resolution process, improve application performance, and reduce the risk of dependency-related issues.

The exclusions cover a wide range of libraries, including popular ones such as Apache Commons, Google libraries, Hibernate, and various logging frameworks. The line continuation characters (\) are used correctly to split the long list across multiple lines for better readability.

Please double-check that no required dependencies are accidentally excluded, as that could lead to runtime errors. You can use the following script to search for any usage of the excluded libraries in the codebase:

If any of the excluded libraries are found to be used in the codebase, please verify if they are actually required and consider removing the exclusion if necessary.

springboot-samples/config/apollo/biz1-apollo/conf/ark/bootstrap.properties (1)

1-13: Comprehensive dependency exclusions for optimized build.

The bootstrap.properties file defines a comprehensive list of artifact and group IDs to be excluded from dependency management. This configuration will help optimize the build process by preventing the inclusion of unnecessary or conflicting libraries.

The exclusions cover a wide range of libraries, including:

  • Common utility libraries (e.g., commons-collections, commons-io)
  • Logging frameworks (e.g., log4j, slf4j)
  • Various Java frameworks (e.g., springframework, hibernate, mybatis)
  • Third-party libraries (e.g., google-guava, netty, okhttp)

By excluding these libraries, the application will remain lightweight and avoid potential conflicts arising from transitive dependencies.

The use of wildcards (*) in the excludeGroupIds property allows for flexible matching of multiple artifacts within a group, providing fine-grained control over the excluded dependencies.

Overall, this configuration enhances the dependency resolution process and contributes to a more efficient and tailored application environment.

springboot3-samples/config/apollo/biz1/conf/ark/bootstrap.properties (1)

1-20: Excellent work on curating the dependency exclusion list!

The extensive list of artifact and group IDs in the excludeArtifactIds and excludeGroupIds properties demonstrates a careful approach to dependency management. By excluding unnecessary libraries and limiting the number of external dependencies, you can achieve several benefits:

  1. Streamlined build process: Excluding unnecessary dependencies can reduce build times and minimize the risk of dependency conflicts.

  2. Improved maintainability: A clean and manageable project structure is easier to understand and maintain over time.

  3. Enhanced performance: Avoiding unnecessary dependencies can lead to better application performance by reducing the overall footprint.

  4. Reduced attack surface: Limiting the number of external libraries can minimize the potential for security vulnerabilities introduced by third-party code.

The exclusions cover a wide range of libraries, including utility libraries, logging frameworks, and various other third-party libraries, indicating a comprehensive approach to dependency management.

Overall, this configuration file is a great addition to the project, promoting better maintainability, performance, and security.

springboot3-samples/config/apollo/biz2/conf/ark/bootstrap.properties (1)

1-20: Excellent work on introducing a comprehensive dependency exclusion configuration!

The bootstrap.properties file serves as a central configuration point for managing dependencies in the Spring Boot application. The extensive list of exclusions covers a wide range of libraries, including utility libraries, logging frameworks, and third-party libraries.

By defining these exclusions, you can:

  • Avoid potential conflicts or issues arising from certain libraries.
  • Ensure a cleaner and more manageable dependency tree.
  • Enhance the application's maintainability and stability.

This configuration is particularly useful in large applications where multiple dependencies may introduce conflicts or unnecessary bloat. It allows developers to easily modify which libraries are included or excluded from the build process.

Overall, the introduction of this file is a great step towards improving the application's dependency management and reducing the risk of dependency-related bugs.

springboot-samples/config/apollo/biz2-apollo/conf/ark/bootstrap.properties (1)

1-16: Comprehensive list of dependency exclusions

The bootstrap.properties file contains a comprehensive list of artifact and group IDs to be excluded from dependency resolution. This careful curation of dependencies can help streamline the application and reduce potential issues related to version conflicts, unnecessary bloat, or security vulnerabilities.

However, it's important to ensure that any required functionality provided by the excluded libraries is properly handled or replaced. Thorough testing should be performed to verify that the application functions as expected with these exclusions in place.

springboot3-samples/config/apollo/README-zh_CN.md (1)

51-51: LGTM!

The change correctly updates the location for specifying the excludeGroupIds configuration to ensure proper delegation of the Apollo client to the base application. The updated instructions are clear and accurate.

springboot-samples/config/apollo/README-zh_CN.md (1)

57-57: Documentation update looks good!

The change clarifies the location of the configuration file where the excludeGroupIds setting should be specified to delegate Apollo client loading to the base application. This improves the documentation and reduces potential confusion for users.

springboot3-samples/config/apollo/README.md (1)

54-54: LGTM!

The instructions for delegating the Apollo client to the base module using automatic slimming are clear and well-documented. Specifying the exact file paths for adding the configuration enhances clarity. The reminder about adding the JMX configuration in application.properties is also relevant and helpful.

springboot-samples/config/apollo/README.md (1)

55-55: LGTM!

The documentation update provides clearer instructions on where to configure the exclusion settings for delegating the Apollo client to a base application. The change from rules.txt to conf/ark/bootstrap.properties or conf/ark/bootstrap.yml aligns with the automatic slimming feature and enhances clarity for users.

springboot-samples/cache/ehcache/README-zh_CN.md (1)

83-83: The configuration change looks good!

Updating the module slimming configuration from rules.txt to conf/ark/bootstrap.properties or conf/ark/bootstrap.yml aligns with the PR objective and seems like a reasonable change.

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.

1 participant