From 4f8e47441914bee14746cc22354e15d3e9ca9a3c Mon Sep 17 00:00:00 2001 From: Carmine Vassallo Date: Tue, 5 Nov 2024 15:11:32 +0100 Subject: [PATCH] SONAR-23541 Update release process for Community Build --- release.md | 28 ++++++++++++++-------------- 1 file changed, 14 insertions(+), 14 deletions(-) diff --git a/release.md b/release.md index 37a90b5a..c835d097 100644 --- a/release.md +++ b/release.md @@ -1,27 +1,27 @@ # Releasing -Docker image release cycle and SonarQube product +Docker image release cycle and SonarQube Server product --- -We consider the **docker image** as part of the SonarQube **product**. Therefore, it follows the same release process. +We consider the **docker image** as part of the SonarQube Server **product**. Therefore, it follows the same release process. Overview -------- -Release of a new version of the official SonarQube Docker images is made of several operations: +Release of a new version of the official SonarQube Server Docker images is made of several operations: -1. bump the version of SonarQube in Dockerfiles -2. bump the version of `CURRENT_LTA_VERSION` and `CURRENT_VERSION` accordingly in `.cirrus/tasks.yml` (please note that the nightly build will fail before the public image becomes available) -3. Update the docker hub SonarQube's documentation (if applicable) -4. Update Docker Hub's SonarQube images +1. set the new version of SonarQube Server (`SONARQUBE_VERSION`) to be released in the Dockerfiles. In case of community build, please remember to update `community-build/Dockerfile` only. +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. Update Docker Hub's SonarQube Server images 5. add a GIT tag for the new version -Bump the version of SonarQube in Dockerfiles +Bump the version of SonarQube Server in Dockerfiles ----------------------------- -The version of SonarQube is hardcoded in each Dockerfile of this repository and must be updated in master branch. +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'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) @@ -35,24 +35,24 @@ To create a good PR: To control the generated content of the Docker Hub page, look around in the files in `.template-helpers` of the [`docs` repository][docs]. For example, the "Where to get help" section is customized by a copy of `.template-helpers/get-help.md` in `sonarqube/get-help.md`. -Until SonarQube 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. +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. For more and up to date documentation, see https://github.com/docker-library/docs. -Update Docker Hub's SonarQube 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 should use your own personal fork +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. * `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 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. +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. * Click on *compare across fork* to be able to use the fork as head repository.