Skip to content

Commit aa71e68

Browse files
Add Maven Wrapper for consistent build environment
1 parent dd4e981 commit aa71e68

File tree

4 files changed

+537
-6
lines changed

4 files changed

+537
-6
lines changed
Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
# Licensed to the Apache Software Foundation (ASF) under one
2+
# or more contributor license agreements. See the NOTICE file
3+
# distributed with this work for additional information
4+
# regarding copyright ownership. The ASF licenses this file
5+
# to you under the Apache License, Version 2.0 (the
6+
# "License"); you may not use this file except in compliance
7+
# with the License. You may obtain a copy of the License at
8+
#
9+
# http://www.apache.org/licenses/LICENSE-2.0
10+
#
11+
# Unless required by applicable law or agreed to in writing,
12+
# software distributed under the License is distributed on an
13+
# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
14+
# KIND, either express or implied. See the License for the
15+
# specific language governing permissions and limitations
16+
# under the License.
17+
distributionUrl=https://repo.maven.apache.org/maven2/org/apache/maven/apache-maven/3.9.6/apache-maven-3.9.6-bin.zip
18+
wrapperUrl=https://repo.maven.apache.org/maven2/org/apache/maven/wrapper/maven-wrapper/3.2.0/maven-wrapper-3.2.0.jar

README.md

Lines changed: 10 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -401,11 +401,11 @@ build errors due to incompatible versions of `Node.js` tooling installed on your
401401

402402
### Preparing Maven
403403

404-
Make sure that you have Maven installed.
404+
This project includes Maven Wrapper, so you don't need to install Maven manually. Just use `./mvnw` (or `mvnw.cmd` on Windows) instead of `mvn`. The wrapper automatically downloads the correct Maven version (3.9.6) on first run.
405405

406-
$ mvn --version
406+
If you prefer using your own Maven installation:
407407

408-
If this command fails with an error, you do not have Maven installed.
408+
$ mvn --version
409409

410410
Please install Maven using your favorite package manager (like [Homebrew](https://brew.sh/)) or from
411411
official [Maven binaries](https://maven.apache.org/install.html)
@@ -423,7 +423,11 @@ When building everything from scratch the build executes following steps:
423423

424424
You can do all of this with one single command:
425425

426-
$ mvn package
426+
$ ./mvnw package
427+
428+
Or on Windows:
429+
430+
> mvnw.cmd package
427431

428432
The whole process takes up to five minutes (time to grab some coffee!)
429433

@@ -434,7 +438,7 @@ When the build is finished you should see the generated website in the `public`
434438
When rebuilding the website you can optimize the build process as some of the steps are only required for a fresh
435439
build from scratch. You can skip the ui theme rendering (unless you have changes in the theme itself).
436440

437-
$ mvn package -Dskip.theme
441+
$ ./mvnw package -Dskip.theme
438442

439443
This should save you some minutes in the build process. You can find the updated website content in the `public` directory.
440444

@@ -445,7 +449,7 @@ When rebuilding the website the process uses some cached content (e.g. the fetch
445449
If you want to start from scratch for some reason you can simply add the `clean` operation to the build which removes
446450
all generated sources in the project first.
447451

448-
$ mvn clean package
452+
$ ./mvnw clean package
449453

450454
Of course this then takes some more time than an optimized rebuild (time to grab another coffee!).
451455

mvnw

Lines changed: 304 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)