From 7114e4a0bef602b09325349b1f7890466534a0e0 Mon Sep 17 00:00:00 2001 From: Rostislav Svoboda Date: Tue, 23 Jan 2024 09:04:10 +0100 Subject: [PATCH 1/2] Building with relocations --- CONTRIBUTING.md | 14 ++++++++++++++ 1 file changed, 14 insertions(+) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index e71961362a993..7fdc0539a5346 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -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) @@ -419,6 +420,19 @@ 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 thus there is +`relocations` profile to provide mapping to new extension coordinates. This can be achieved by executing the following +command: + +``` +./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` From 0adf7a08f05573e70fc3f6f0d7c4514e579e0100 Mon Sep 17 00:00:00 2001 From: Guillaume Smet Date: Tue, 23 Jan 2024 14:53:07 +0100 Subject: [PATCH 2/2] Tweak content a bit --- CONTRIBUTING.md | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 7fdc0539a5346..e3933a5d32d15 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -423,9 +423,10 @@ 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 thus there is -`relocations` profile to provide mapping to new extension coordinates. This can be achieved by executing the following -command: +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