Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
gsmet committed Jan 17, 2024
1 parent 3fdbe65 commit f68bfbd
Showing 1 changed file with 26 additions and 0 deletions.
26 changes: 26 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,13 +2,39 @@

<p align="center"><img src="https://design.jboss.org/quarkus/bot/final/images/quarkusbot_full.svg" width="128" height="128" /></p>

## About

This repository is used to release the [Quarkus framework](https://quarkus.io/).

Releases are handled automatically by GitHub Actions (with some human interactions and a few manual steps - they are clearly described) using the the [Conversational Release Action](https://github.com/quarkusio/conversational-release-action) which orchestrates the [historical release scripts](https://github.com/quarkusio/quarkus-release) (these scripts are still usable directly if needed).

Even if the process is far more guided with this new approach, releases should still be started by Quarkus maintainers who are aware of the release process.

## Starting a release

To start a release, create a [new issue](https://github.com/quarkus-release/release/issues/new?assignees=&labels=kind%2Frelease&projects=&template=release.yml).
It will start a workflow run that will guide you through the release process.

### Examples

#### 3.8.0.CR1

- <kbd>Branch</kbd> `3.8` (the branch will be created automatically)
- <kbd>Qualifier</kbd> `CR1`
- <kbd>Major version</kbd>

#### 3.8.x

- <kbd>Branch</kbd> `3.8`
- <kbd>Qualifier</kbd>
- <kbd>Major version</kbd>

#### 4.0.0.CR1

- <kbd>Branch</kbd> `4.0` (the branch will be created automatically)
- <kbd>Qualifier</kbd> `CR1`
- <kbd>Major version</kbd> ✔️

## Questions

If you have any questions about the process, please ping `@gsmet`.

0 comments on commit f68bfbd

Please sign in to comment.