Skip to content
New issue

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

Sign up for GitHub

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

Already on GitHub? Sign in to your account

Jump to bottom

Update README about build tools #9545

Merged
merged 7 commits into from
Apr 5, 2023
Merged

Update README about build tools #9545

Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
8bf1cc9
Update README about build tools
joakime Mar 27, 2023
00f3ae7
Add Docker as tool needed for third party testing
olamy Mar 28, 2023
cf37c6b
fast build and jdk to use
olamy Mar 28, 2023
8273699
Improved README
joakime Mar 28, 2023
62cd4b2
Even more build details in README
joakime Mar 28, 2023
4fea53b
Cleanup runner locations/branches
joakime Mar 28, 2023
3638d0d
Split jetty-runner rows
joakime Apr 4, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
37 changes: 31 additions & 6 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -46,19 +46,44 @@ Project documentation is available on the Jetty Eclipse website.
Building
========

To build, use:
[Apache Maven 3.8.0](https://maven.apache.org/) and [OpenJDK](https://adoptium.net/) requirements:

Branch | Maven Version | Minimum JDK | Recommended JDK
---------------|---------------|-------------| ---------------
`jetty-10.0.x` | Maven 3.8.6+ | OpenJDK 11 | OpenJDK 17 (for optional loom and http/3 support)
`jetty-11.0.x` | Maven 3.8.6+ | OpenJDK 11 | OpenJDK 17 (for optional loom and http/3 support)
`jetty-12.0.x` | Maven 3.8.6+ | OpenJDK 17 | OpenJDK 17
gregw marked this conversation as resolved.
Show resolved Hide resolved

Full Build with All Tests:

``` shell
mvn clean install
```

Fast Build if you need jars and distribution (not running tests, checkstyle, enforcer, license check):

``` shell
mvn clean install
mvn -Pfast clean install
```
Optional build tools:

Eclipse Jetty will be built in `jetty-home/target/jetty-home`.
* [`graphviz`](https://graphviz.org/) - used by asciidoctor in the jetty-documentation build to produce various graphs
* [`Docker`](https://www.docker.com/) - used to run some integration tests for testing third party integrations

The first build may take a longer than expected as Maven downloads all the dependencies.
Once the build is complete, you can find the built Jetty Maven artifacts in your Maven local repository.
Along with the following locations of note:

The build tests do a lot of stress testing, and on some machines it is necessary to set the file descriptor limit to greater than 2048 for the tests to all pass successfully.
Branches | Location | Description
---------------|-------------------------------------------------------------------|---------
all | `jetty-home/target/jetty-home-<ver>.tar.gz` | The Jetty Home standalone tarball
`jetty-10.0.x` | `jetty-runner/target/jetty-runner-<ver>.jar` | The Jetty Runner uber jar
`jetty-11.0.x` | `jetty-runner/target/jetty-runner-<ver>.jar` | The Jetty Runner uber jar
`jetty-12.0.x` | `jetty-ee10/jetty-ee10-runner/target/jetty-ee10-runner-<ver>.jar` | The Jetty Runner uber jar for ee10/Servlet 6 (jakarta.servlet) webapps
`jetty-12.0.x` | `jetty-ee9/jetty-ee9-runner/target/jetty-ee9-runner-<ver>.jar` | The Jetty Runner uber jar for ee9/Servlet 5 (jakarta.servlet) webapps
`jetty-12.0.x` | `jetty-ee8/jetty-ee8-runner/target/jetty-ee8-runner-<ver>.jar` | The Jetty Runner uber jar for ee8/Servlet 4 (javax.servlet) webapps

It is possible to bypass tests by building with `mvn clean install -DskipTests`.
Note: The build tests do a lot of stress testing, and on some machines it is necessary to set the
file descriptor limit to greater than 2048 for the tests to all pass successfully (check your `ulimit -n` value).

Professional Services
---------------------
Expand Down