Skip to content

Commit

Permalink
Merge pull request quarkusio#27142 from reda-alaoui/patch-1
Browse files Browse the repository at this point in the history
Document the release process
  • Loading branch information
gsmet authored Sep 13, 2022
2 parents 20d9c4f + e3f4dfe commit 602ed25
Showing 1 changed file with 28 additions and 0 deletions.
28 changes: 28 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +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 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)
Expand Down Expand Up @@ -502,6 +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 your own 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.z-yourcompany"
```

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 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
Expand Down

0 comments on commit 602ed25

Please sign in to comment.