Skip to content

Commit

Permalink
Simplified the process as we will use 999 as the release version in u…
Browse files Browse the repository at this point in the history
…pstream similar to the main repository.

Signed-off-by: Alexander Schwartz <[email protected]>
  • Loading branch information
ahus1 committed Jan 28, 2025
1 parent 9459d30 commit 8be3e84
Showing 1 changed file with 2 additions and 27 deletions.
29 changes: 2 additions & 27 deletions doc/benchmark/modules/ROOT/pages/release.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ The changes are often in the "dataset" provider but are not limited to that.
. Make sure that everything needed is committed
and pushed inside https://github.com/keycloak/keycloak-benchmark in the `main` branch.
On your local from the HEAD of the `main` branch,
create a new release branch with this signature `0.XX-release`, for example `0.13-release`.
create a new release branch with this signature `XX-release`, for example `25.0-release`.
In that release branch,
make the below series of updates
to upgrade the version which are required for a Keycloak Benchmark's SNAPSHOT release to be successful.
Expand All @@ -19,32 +19,7 @@ to upgrade the version which are required for a Keycloak Benchmark's SNAPSHOT re
. Now perform a project wide search for the below keywords and replace them with the respective ones appropriately as per the release.
* Search for `nightly` and replace it with `25.0.1`, if the release is performed against the `Keycloak 25.0.1` build.
* Search for `keycloak-999.0.0-SNAPSHOT` and replace it with `keycloak-25.0.1`, if the release is performed against the `Keycloak 25.0.1` build.
* Search for `999.0.0` and replace it with `25.0.1`, if the release is performed against the `Keycloak 25.0.1` build.
+
. Now push your changes from your local `XX-release` branch to the remote `XX-release` branch, which in turn generates the specific artifacts necessary for the SNAPSHOT release.

== Post Release steps
. Once the `release` branch is cut and the SNAPSHOT release generates its artifacts successfully, perform the below steps against the `main` branch in order to propagate the new changes into a newer SNAPSHOT version. While these post-release steps, have to be executed manually, we hope to automate them to a single click release workflow in the future.
. Upgrade to the new SNAPSHOT versions in all the locations inside the below files.
For example, after performing a `0.13-SNAPSHOT` release,
search for `0.13-SNAPSHOT` keyword in the files below and replace it with the next logical version number,
in this case with `0.14-SNAPSHOT`.
** Keycloak Benchmark ROOT
* link:{github-files}/pom.xml#L7[pom.xml].
** Benchmark module
* link:{github-files}/benchmark/pom.xml[benchmark/pom.xml].
* link:{github-files}/doc/benchmark/antora.yml[antora.yml] file under the Benchmark docs.
* link:{github-files}/doc/benchmark/modules/ROOT/pages/report/rosa-benchmark-key-results.adoc[ROSA Benchmark key results] page.
* link:{github-files}/doc/benchmark/modules/ROOT/pages/run/running-benchmark-ansible.adoc[Running benchmark using Ansible] page.
+
** Dataset module
* link:{github-files}/dataset/pom.xml[dataset/pom.xml].
* link:{github-files}/dataset/src/test/java/org/keycloak/benchmark/test/KeycloakServer.java[KeycloakServer.java] update the default `project_version`.
* link:{github-files}/doc/dataset/antora.yml[antora.yml] file under the Dataset docs.
+
** Kubernetes module
* link:{github-files}/provision/rosa-cross-dc/keycloak-benchmark-crossdc-tests/pom.xml[pom.xml] for ROSA Cross DC functional tests.
* link:{github-files}/doc/kubernetes/antora.yml[antora.yml] file under the Kubernetes docs.
** Ansible module
* link:{github-files}/ansible/env_example.yml[ansible/env_example.yml].
* link:{github-files}/ansible/env_rosa_benchmark.yml[ansible/env_rosa_benchmark.yml].
. Once the changes are all in place, commit these to the `main` branch with a good commit message to indicate the project has now been upgraded to a newer SNAPSHOT release.

0 comments on commit 8be3e84

Please sign in to comment.