Repository navigation
docs: update outdated Gradle information for Vaadin 25 (#6364) (CP: v25.3) - #6366
Merged
Merged
Conversation
Fixes #2567. The Getting Started Gradle page still described Vaadin 24-era requirements and Java EE setup. This rewrites it against Vaadin 25 and the current [`base-starter-gradle`](https://github.com/vaadin/base-starter-gradle) and [`base-starter-spring-gradle`](https://github.com/vaadin/base-starter-spring-gradle) starters. ## Getting Started › Starters › Gradle - **Requirements**: Java 21 and Gradle 8.14, matching `GRADLE_MINIMUM_SUPPORTED_VERSION` and the Java 21 target in `flow-gradle-plugin`, with a link to Supported Technologies. - **Build files**: replaces the plugins-only snippet with the setup the starters use. The Vaadin version goes in `gradle.properties` (as the upgrade guide already says), the plugin version in `settings.gradle`, and the BOM in `build.gradle`. There are tabs for Spring Boot and for a plain WAR project. Both show how `vaadin-dev` stays out of the production build. Versions come from the `{vaadin-version}` and `{spring-boot-version}` attributes, not a hard-coded `25.0.0`. - **Servlet API**: drops `javax.servlet-api:3.1.0` and the `javax:javaee-api` suggestion. Flow declares the Jakarta Servlet API as `provided`, so the page says to add `jakarta.servlet-api:6.1.0` with `providedCompile` only when code uses it directly. - **Gretty**: Gretty 5 with `jetty12` (Gretty 5 is the first release that supports Jetty 12 and Tomcat 11). The link now goes to the maintained `gretty-gradle-plugin/gretty` project instead of the abandoned akhikhl docs. - **Production**: adds the "Building for Production" section the meta description promises: `bootJar` for Spring Boot, and `build -Pvaadin.productionMode=true` for WAR. It links to the Flow page for details. - **Cleanup**: removes the empty `--`/`--` block, the "gradle.build" typo, and the "much simpler. It's also more powerful" phrasing. ## Flow › Configuration › Gradle - Same requirements fix (it said Java 17 and Gradle 8.7), and the same empty block removed. ## Verification I put the documented `gradle.properties`, `settings.gradle`, and `build.gradle` (with Vaadin 25.3.1, since the alpha on `main` isn't on the Plugin Portal) into clones of both starters and ran them: - `./gradlew clean build -Pvaadin.productionMode=true` (plain) and `./gradlew clean bootJar` (Spring Boot) both succeed. The WAR and the JAR each contain the production bundle with `productionMode: true`, and neither contains `vaadin-dev`. - `./gradlew appRun` starts Jetty 12.0.29 through Gretty 5.0.2, and `./gradlew bootRun` starts the app. Both serve the app in development mode. - Vale reports no errors or warnings on either page. 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-authored-by: Claude Opus 5.5 <noreply@anthropic.com>
Contributor
Preview DeploymentThis PR has been deployed for preview. URL: https://docs-preview-pr-6366.fly.dev Changed pagesAdded content is highlighted in green; removed content is marked in red on each page.
Base branch changesNot marked in the preview: v25.3 is a maintenance branch, not a stacked pull request branch. Everything highlighted in the preview belongs to this PR. Built from b02dec1 |
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
2 participants
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.
No description provided.