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.

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

Document the flags to make the full build faster #8264

Merged
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 5 additions & 6 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -100,21 +100,20 @@ select the `eclipse.importorder` file as the import order config file.
* Clone the repository: `git clone https://github.com/quarkusio/quarkus.git`
* Navigate to the directory: `cd quarkus`
* Set Maven heap to 1.5GB `export MAVEN_OPTS="-Xmx1563m"`
* Invoke `./mvnw clean install` from the root directory
* Invoke `./mvnw clean install -DskipTests -DskipITs -DskipDocs` from the root directory

```bash
git clone https://github.com/quarkusio/quarkus.git
cd quarkus
export MAVEN_OPTS="-Xmx1563m"
./mvnw clean install
./mvnw clean install -DskipTests -DskipITs -DskipDocs
# Wait... success!
```

The default build does not create native images, which is quite time consuming.
This build skipped all the tests, native-image builds and documentation generation.

Note that the full build with all tests is quite slow, you will usually want to build with `-DskipTests`. This will also
skip creation of the integration-test runner jars. If you want to skip tests but still create the runners you can set
`-DskipTests -Dquarkus.build.skip=false`
Removing the `-DskipTests -DskipITs` flags enables the tests.
It will take much longer to build but will give you more guarantees on your code.

You can build and test native images in the integration tests supporting it by using `./mvnw install -Dnative`.

Expand Down