Skip to content

ci: add demo-war profile #17

New issue

Have a question about this project? # for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “#”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? # to your account

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

ci: add demo-war profile #17

wants to merge 1 commit into from

Conversation

javier-godoy
Copy link
Member

@javier-godoy javier-godoy commented Feb 20, 2025

See https://github.com/FlowingCode/AddonStarter24/pull/57

Summary by CodeRabbit

  • New Features
    • Introduced a demo packaging option that leverages production mode and streamlined resource management to enhance dependency handling and package creation for demo deployments.

Copy link

coderabbitai bot commented Feb 20, 2025

Walkthrough

The changes introduce a new Maven profile named demo-war in the pom.xml file. This profile sets the vaadin.productionMode property to true and defines dependencies—including vaadin-core (with an exclusion for vaadin-dev), commons-demo, and slf4j-simple. It also configures build plugins: the maven-antrun-plugin to copy and clean up specific resource directories during the process-sources phase, the vaadin-maven-plugin for frontend preparation during compilation, and the maven-war-plugin to create a WAR file without a web.xml.

Changes

File(s) Change Summary
pom.xml Added the demo-war Maven profile with production-mode property, specific dependency configurations (including an exclusion in vaadin-core), and build plugins setup: maven-antrun-plugin (for file copying and cleanup), vaadin-maven-plugin (for frontend processing), and maven-war-plugin (for WAR packaging without web.xml).

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 generate docstrings to generate docstrings for this PR. (Beta)
  • @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 (2)
pom.xml (2)

508-528: Dependencies Configuration in Demo-War Profile
The dependencies are configured appropriately for the demo WAR package. The vaadin-core dependency correctly excludes vaadin-dev, and the inclusion of commons-demo meets the demo requirements. One suggestion is to verify whether an explicit version should be provided for slf4j-simple—unless it is managed in a parent or global dependency management section—to avoid potential inconsistencies across environments.


529-597: Build Plugins Setup in Demo-War Profile
The build section nicely composes the required plugins:

  • The maven-antrun-plugin (version 1.7) is used to perform multiple resource copy and cleanup operations, which is a practical solution for reorganizing source and resource directories.
  • The vaadin-maven-plugin is configured to prepare and build the frontend in the compile phase, aligning with Vaadin’s build process.
  • The maven-war-plugin is properly set up to generate a WAR without a web.xml, which is standard for modern web applications.

A couple of considerations:

  • The use of failonerror="false" in the <copy> and <delete> tasks is a defensive choice; ensure that silently ignoring errors is acceptable for your CI/CD pipeline.
  • Consider evaluating if upgrading the maven-antrun-plugin version could offer improved performance or additional safeguards, if applicable to your project requirements.
📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 79a334c and 0ba2c1c.

📒 Files selected for processing (1)
  • pom.xml (2 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (1)
  • GitHub Check: build-vaadin24
🔇 Additional comments (1)
pom.xml (1)

503-507: Profile Declaration and Production Mode Property Validity
The new "demo-war" profile correctly establishes the intended environment by setting <vaadin.productionMode>true</vaadin.productionMode>. This ensures that the application runs in production mode when this profile is activated.

@javier-godoy javier-godoy force-pushed the master branch 2 times, most recently from 2409741 to 1c575c0 Compare April 16, 2025 18:40
Copy link
Member

@mlopezFC mlopezFC left a comment

Choose a reason for hiding this comment

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

LGTM

# for free to join this conversation on GitHub. Already have an account? # to comment
Labels
None yet
Projects
Status: In Progress
Development

Successfully merging this pull request may close these issues.

2 participants