Skip to content

Commit

Permalink
Add more info about releasing to CONTRIBUTING.md
Browse files Browse the repository at this point in the history
  • Loading branch information
gsmet committed Sep 13, 2022
1 parent a9e0f55 commit e3f4dfe
Showing 1 changed file with 19 additions and 12 deletions.
31 changes: 19 additions & 12 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand Down Expand Up @@ -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
Expand Down

0 comments on commit e3f4dfe

Please sign in to comment.