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

Building with relocations #38341

Merged
merged 2 commits into from
Jan 23, 2024
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
15 changes: 15 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,7 @@ fixes, documentation, examples... But first, read this page (including the small
+ [Workflow tips](#workflow-tips)
- [Building all modules of an extension](#building-all-modules-of-an-extension)
- [Building a single module of an extension](#building-a-single-module-of-an-extension)
- [Building with relocations](#building-with-relocations)
- [Running a single test](#running-a-single-test)
* [Maven Invoker tests](#maven-invoker-tests)
+ [Build with multiple threads](#build-with-multiple-threads)
Expand Down Expand Up @@ -419,6 +420,20 @@ or

In this command we use the groupId and artifactId of the module to identify it.

#### Building with relocations

Let's say you want to make changes to an extension and try it with an existing application that uses older Quarkus with
extensions that got renamed or moved recently.
Quarkus maintains compatibility as much as possible and for most renamed or moved artifact, it provides a relocation artifact,
allowing the build to be redirected to the new artifact.
However, relocations are not built by default, and to build and install them, you need to enable the `relocations` Maven profile as follows:

```
./mvnw -Dquickly -Prelocations
```

Relocations are published with every Quarkus release, thus this is needed only when working with Quarkus main.

#### Running a single test

Often you need to run a single test from some Maven module. Say for example you want to run the `GreetingResourceTest`
Expand Down