From d3d8317930262d2e77489d42a599df4a61ab95b6 Mon Sep 17 00:00:00 2001 From: Davi Koscianski Vidal Date: Thu, 9 Jan 2025 09:39:10 +0100 Subject: [PATCH] Minor release doc update; changes markdown titles --- release.md | 29 +++++++++++------------------ 1 file changed, 11 insertions(+), 18 deletions(-) diff --git a/release.md b/release.md index 7c2646cf..b606aa7f 100644 --- a/release.md +++ b/release.md @@ -1,11 +1,10 @@ # Releasing -Docker image release cycle and SonarQube Server product ---- +## Docker image release cycle and SonarQube Server product + We consider the **docker image** as part of the SonarQube Server **product**. Therefore, it follows the same release process. -Overview --------- +## Overview Release of a new version of the official SonarQube Server Docker images is made of several operations. (Please note that in case of a patch release that should not include the latest changes on master, you need to release from a new branch - e.g., `release/10.8.1` - and propagate the changes to master afterwards). @@ -13,18 +12,15 @@ Release of a new version of the official SonarQube Server Docker images is made 2. If you are releasing a new LTA, set `CURRENT_LTA_VERSION` in `.cirrus/tasks.yml`. Otherwise, if you are releasing a Community build, set `COMMUNITY_BUILD_VERSION` only. In all the other cases where a paid edition is about to be releases, set `CURRENT_VERSION` (please note that the nightly build will fail before the public image becomes available). 3. Update the docker hub SonarQube Server's documentation (if applicable) 4. Add a GIT tag for the new version - 1. If you are releasing a SonarQube Server version, you need to [Draft a New Release](https://github.com/SonarSource/docker-sonarqube/releases/new), where the name matches "SonarQube Server 2025." + 1. If you are releasing a SonarQube Server version, you need to [Draft a New Release](https://github.com/SonarSource/docker-sonarqube/releases/new), where the name matches "SonarQube Server 2025.", followed by the month version, i.e., "SonarQube Server 2025.1". 2. Likewise, if you are releasing a Community Build, the release name should match "Community Build", followed by the month version, i.e., "Community Build 25.1". 5. Update Docker Hub's SonarQube Server images - -Bump the version of SonarQube Server in Dockerfiles ------------------------------ +## Bump the version of SonarQube Server in Dockerfiles The version of SonarQube Server is hardcoded in each Dockerfile of this repository and must be updated in master branch. -Update the docker hub SonarQube Server's documentation (if applicable) -------------------------------- +## Update the docker hub SonarQube Server's documentation (if applicable) If needed, prepare PR of Docker Hub documentation [https://github.com/docker-library/docs](https://github.com/docker-library/docs) @@ -41,30 +37,27 @@ Until SonarQube Server is released and the public artifacts are available, keep For more and up to date documentation, see https://github.com/docker-library/docs. - -Update Docker Hub's SonarQube Server images ------------------------ +## Update Docker Hub's SonarQube Server images In order to update the Docker Hub images, a Pull Request must be created on the [official-images](https://github.com/docker-library/official-images) repository. To do so you can use your own personal fork. Create a feature branch on the fork: + * `GitCommit` must be updated to this repository master branch's HEAD. * `GitFetch` is the branch/tag (e.g., refs/tags/10.8.1) where the commit can be found. Setting this value is only needed if you are releasing from a branch different from master. * `Tags` and `Directory` must be added/updated appropriatly for each edition * see https://github.com/docker-library/official-images/pull/8837/files as an example Until SonarQube Server is released and the public artifacts are available, keep your PR a draft PR to make it clear it is not ready to be merged yet. + * Create the PR [here](https://github.com/docker-library/official-images/compare) - * If the documentation was updated in the step before, reference that PR in this PR. + * If the documentation was updated in the step before, reference that PR in this PR. * Click on *compare across fork* to be able to use the fork as head repository. - For more and up to date documentation, see https://github.com/docker-library/official-images. - -Add a GIT tag for the new version ----------------- +## Add a GIT tag for the new version The commit referenced in the DockerHub Pull Request must be tagged with the (marketing) version of SQ: eg. `8.0`, `8.0.1`, `8.1`.