Skip to content

Conversation

@adriangc24
Copy link

@adriangc24 adriangc24 commented Jun 15, 2025

Before command not working, updated to:
mvn clean verify -Djarsigner.skip=true
-Djdk.xml.maxGeneralEntitySizeLimit=0
-Djdk.xml.totalEntitySizeLimit=0

Description

Please include a summary of the change and which issue is fixed.

Fixes # (IEP-XXX)

Type of change

Please delete options that are not relevant.

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • This change requires a documentation update

How has this been tested?

Please describe the tests that you ran to verify your changes. Provide instructions so we can reproduce. Please also list any relevant details for your test configuration

  • Test A
  • Test B

Test Configuration:

  • ESP-IDF Version:
  • OS (Windows,Linux and macOS):

Dependent components impacted by this PR:

  • Component 1
  • Component 2

Checklist

  • PR Self Reviewed
  • Applied Code formatting
  • Added Documentation
  • Added Unit Test
  • Verified on all platforms - Windows,Linux and macOS

Summary by CodeRabbit

  • Documentation
    • Updated the Maven build command in the README to include additional JVM system properties for improved configuration.

Before command not working, updated to:
mvn clean verify -Djarsigner.skip=true \
  -Djdk.xml.maxGeneralEntitySizeLimit=0 \
  -Djdk.xml.totalEntitySizeLimit=0
@coderabbitai
Copy link

coderabbitai bot commented Jun 15, 2025

Walkthrough

The Maven build command in the README file was updated to include two additional JVM system properties related to XML entity size limits. No other files or documentation were changed.

Changes

File(s) Change Summary
README.md Updated Maven build command to add -Djdk.xml.maxGeneralEntitySizeLimit=0 and -Djdk.xml.totalEntitySizeLimit=0 JVM properties.

Suggested reviewers

  • kolipakakondal
  • alirana01

Poem

A tweak to the README, so small yet precise,
Two JVM flags now join the advice.
Building with Maven, our limits set free,
XML entities as vast as can be!
The rabbit approves, with a hop and a cheer—
Onward to building, with nothing to fear! 🐇✨


Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ 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.
    • Explain this complex logic.
    • 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 explain this code block.
    • @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 explain its main purpose.
    • @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.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

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 generate docstrings to generate docstrings for this PR.
  • @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this 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

🧹 Nitpick comments (1)
README.md (1)

30-32: Replace hard tabs with spaces for code block indentation
The inserted Maven command lines use hard tabs, triggering markdownlint MD010. Replace with spaces to maintain consistent formatting across the code block.
Suggested diff:

-	mvn clean verify -Djarsigner.skip=true \
-	  -Djdk.xml.maxGeneralEntitySizeLimit=0 \
-	  -Djdk.xml.totalEntitySizeLimit=0
+    mvn clean verify -Djarsigner.skip=true \
+        -Djdk.xml.maxGeneralEntitySizeLimit=0 \
+        -Djdk.xml.totalEntitySizeLimit=0
🧰 Tools
🪛 markdownlint-cli2 (0.17.2)

30-30: Hard tabs
Column: 1

(MD010, no-hard-tabs)


31-31: Hard tabs
Column: 1

(MD010, no-hard-tabs)


32-32: Hard tabs
Column: 1

(MD010, no-hard-tabs)

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between a7c30c2 and f3810a8.

📒 Files selected for processing (1)
  • README.md (1 hunks)
🧰 Additional context used
🪛 markdownlint-cli2 (0.17.2)
README.md

30-30: Hard tabs
Column: 1

(MD010, no-hard-tabs)


31-31: Hard tabs
Column: 1

(MD010, no-hard-tabs)


32-32: Hard tabs
Column: 1

(MD010, no-hard-tabs)

@github-actions github-actions bot changed the title Update README.md new mvn clean command Update README.md new mvn clean command (IEP-1560) Jun 15, 2025
mvn clean verify -Djarsigner.skip=true
mvn clean verify -Djarsigner.skip=true \
-Djdk.xml.maxGeneralEntitySizeLimit=0 \
-Djdk.xml.totalEntitySizeLimit=0
Copy link
Collaborator

Choose a reason for hiding this comment

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

Thanks for the PR. While this can help bypass errors with large XML files, setting these limits to zero disables important protections against XML. These limits are in place to prevent malicious or accidental resource exhaustion

Best practice is to only increase these limits as much as necessary when needed, not to remove them entirely. If we are hitting the default limits, we should set them to a large but finite value that is sufficient for our use case (e.g., -Djdk.xml.totalEntitySizeLimit=200000000 for 200MB), rather than disabling the limit.

For now, I am not merging this change.

Thanks again for your effort and understanding!

@kolipakakondal
Copy link
Collaborator

I regularly use the same build command and haven’t encountered XML entity size limit errors, either locally or on our CI systems.

I use java 21.

In general, we should avoid disabling these limits unless absolutely necessary, as discussed above.

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.

2 participants