doc: Improve Gradle plugin documentation (V24)#5476
Open
mcollovati wants to merge 1 commit intov24from
Open
Conversation
The Vaadin Gradle plugin does not read `application.properties`, so
settings like `vaadin.frontend.hotdeploy=true` only take effect at
runtime, not during Gradle builds. This was not documented, causing
issues where `vaadinPrepareFrontend` would delete generated frontend
files during IDE-triggered builds.
- Clarify that the Gradle plugin requires configuration via the
`vaadin {}` block in `build.gradle`, not `application.properties`
- Add missing `frontendHotdeploy` to the plugin configuration options
- Add Gradle tab to the "Disabling the Pre-Compiled Bundle" section
- Document that `vaadinPrepareFrontend` is bound to `processResources`
and runs on every compilation
- Add IntelliJ IDEA workarounds to Known Issues and run guide
Part of vaadin/flow#24108
AI Language ReviewThe changes between the
Overall, the modifications and additions improve clarity regarding the setup and configuration of Vaadin projects in IntelliJ IDEA with Gradle. The new instructions are detailed and provide practical advice for avoiding common pitfalls related to IDE and build tool interactions. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
The Vaadin Gradle plugin does not read
application.properties, so settings likevaadin.frontend.hotdeploy=trueonly take effect at runtime, not during Gradle builds. This was not documented, causing issues wherevaadinPrepareFrontendwould delete generated frontend files during IDE-triggered builds.vaadin {}block inbuild.gradle, notapplication.propertiesfrontendHotdeployto the plugin configuration optionsvaadinPrepareFrontendis bound toprocessResourcesand runs on every compilationPart of vaadin/flow#24108