From e3f4dfe7c545f8a5fff8a9222238fa34dc1b835d Mon Sep 17 00:00:00 2001 From: Guillaume Smet Date: Tue, 13 Sep 2022 14:45:04 +0200 Subject: [PATCH] Add more info about releasing to CONTRIBUTING.md --- CONTRIBUTING.md | 31 +++++++++++++++++++------------ 1 file changed, 19 insertions(+), 12 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 4447050150dc1..07e2bb691bc79 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -35,7 +35,7 @@ fixes, documentation, examples... But first, read this page (including the small - [Automatic incremental build](#automatic-incremental-build) * [Special case `bom-descriptor-json`](#special-case--bom-descriptor-json-) * [Usage by CI](#usage-by-ci) -* [Release](#release) +* [Release your own version](#release) * [Documentation](#documentation) + [Building the documentation](#building-the-documentation) + [Referencing a new guide in the index](#referencing-a-new-guide-in-the-index) @@ -503,26 +503,33 @@ CI is using a slightly different GIB config than locally: For more details see the `Get GIB arguments` step in `.github/workflows/ci-actions-incremental.yml`. -## Release +## Release your own version -To release version `x.y`, first update the version: +You might want to release your own patched version of Quarkus to an internal repository. + +To do so, you will first need to update the version in the source code: ```shell -./update-version.sh "x.y" +./update-version.sh "x.y.z-yourcompany" ``` -Commit the changes then run: +We use a shell script as we also need to update the version in various descriptors and test files. +The shell script calls `./mvnw versions:set` under the hood, among other things. + +Commit the changes, then run: ```shell -./mvnw --settings .github/mvn-settings.xml \ - -B \ - -Prelease \ - -DskipTests -DskipITs \ - -Ddokka \ - -Dgpg.skip \ - clean deploy +./mvnw --settings your-maven-settings.xml \ + clean deploy \ + -DskipTests -DskipITs \ + -DperformRelease=true \ + -Prelease \ + -Ddokka \ + -Dgpg.skip ``` +If your Maven settings are in your global Maven settings file located in the `.m2/` directory, you can drop the `--settings your-maven-settings.xml` part. + ## Documentation The documentation is hosted in the [`docs` module](https://github.com/quarkusio/quarkus/tree/main/docs) of the main