Skip to content

Commit f6891b7

Browse files
authored
Fix and add some content to the release documentation (#11383)
Signed-off-by: Paolo Patierno <ppatierno@live.com>
1 parent 8a46542 commit f6891b7

File tree

1 file changed

+11
-9
lines changed

1 file changed

+11
-9
lines changed

development-docs/RELEASE.md

Lines changed: 11 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -13,13 +13,13 @@ The release process should normally look like this:
1313
1. Create a release branch starting from the `main` one. The new release branch has to be named like `release-<Major>.<minor>.x`, for example `release-0.45.x` to be used for all patch releases for the 0.45.
1414
2. On the `main` git branch of the repository:
1515
* Update the versions to the next SNAPSHOT version using the `next_version` `make` target. For example to update the next version to `0.46.0-SNAPSHOT` run: `NEXT_VERSION=0.46.0-SNAPSHOT make next_version`.
16-
* Update the product version in the `documentation/shared/attributes.adoc` file to the next version by setting the `ProductVersion` variable
16+
* Update the product version in the `documentation/shared/attributes.adoc` file to the next version by setting the `ProductVersion` variable and also the previous version by setting the `ProductVersionPrevious` variable.
1717
* Add a header for the new release to the `CHANGELOG.md` file
1818
3. Move to the release branch and run `make clean`
1919
4. Use the `RELEASE_VERSION` environment variable to set the desired version
2020
* Use always the GA version here (e.g. `0.45.0`) and not the RC version (e.g `0.45.0-rc1`)
2121
5. Run `RELEASE_VERSION=<desired version> make release`, for example `RELEASE_VERSION=0.45.0 make release`
22-
* This will automatically update several `pom.xml` files and all files in `packaging/`, `install/`, `example/` and `helm-chart/` folders.
22+
* This will automatically update several `pom.xml` files and all files in `packaging/`, `install/`, `example/` and `helm-charts/` folders.
2323
6. Update the checksums for released files in `.checksums` in the release branch
2424
* Use the Make commands `make checksum_examples`, `make checksum_install`, and `make checksum_helm` to generate the new checksums
2525
* Updated the checksums in the `.checksums` file in the root directory of the GitHub repository
@@ -39,7 +39,8 @@ The release process should normally look like this:
3939
* Mark the build in the Azure Pipelines UI to be retained forever
4040
12. Create a GitHub tag and release based on the release branch. Attach the release artifacts and docs as downloaded from the Azure pipelines.
4141
* For RCs, the tag should be named with the RC suffix, e.g. `0.45.0-rc1`
42-
13. _(only for GA, not for RCs)_ Update the website
42+
13. Run system tests pipelines. For more details see [Running Azure System Tests pipelines](#running-azure-system-tests-pipelines) section.
43+
14. _(only for GA, not for RCs)_ Update the website
4344
* Update the `_redirects` file to make sure the `/install/latest` redirect points to the new release.
4445
* Update the `_data/releases.yaml` file to add new release
4546
* Update the documentation:
@@ -63,15 +64,15 @@ The release process should normally look like this:
6364
* The updated `index.yaml` will be generated in the directory with the artifacts.
6465
Verify the added data and the digest and if they are correct, copy it to `charts/index.yaml` on the website.
6566
66-
14. _(only for GA, not for RCs)_ On the `main` git branch of the repository:
67+
15. _(only for GA, not for RCs)_ On the `main` git branch of the repository:
6768
* Update the `ProductVersion` variable in `documentation/shared/attributes.adoc`
6869
* Update the `install`, `examples` and `helm-chart` directories in the `main` branch with the newly released files
6970
* Update the checksums for released files in `.checksums`
7071
71-
15. _(only for GA, not for RCs)_ The maven artifacts (`api` module) will be automatically staged from Azure during the tag build. It has to be releases from [Sonatype](https://oss.sonatype.org/#stagingRepositories) to get to the main Maven repositories.
72-
16. _(only for GA, not for RCs)_ Update the Strimzi manifest files in Operator Hub [community operators](https://github.com/operator-framework/community-operators) repository and submit a pull request upstream. *Note*: Instructions for this step need updating.
73-
17. _(only for GA, not for RCs)_ Add the new version to the `systemtest/src/test/resources/upgrade/BundleUpgrade.yaml` file for the upgrade tests
74-
18. _(only for GA, not for RCs)_ Add the new version to the `systemtest/src/test/resources/upgrade/BundleDowngrade.yaml` file and remove the old one for the downgrade tests
72+
16. _(only for GA, not for RCs)_ The maven artifacts (`api` module) will be automatically staged from Azure during the tag build. It has to be releases from [Sonatype](https://oss.sonatype.org/#stagingRepositories) to get to the main Maven repositories.
73+
17. _(only for GA, not for RCs)_ Update the Strimzi manifest files in Operator Hub [community operators](https://github.com/operator-framework/community-operators) repository and submit a pull request upstream. *Note*: Instructions for this step need updating.
74+
18. _(only for GA, not for RCs)_ Add the new version to the `systemtest/src/test/resources/upgrade/BundleUpgrade.yaml` file for the upgrade tests
75+
19. _(only for GA, not for RCs)_ Add the new version to the `systemtest/src/test/resources/upgrade/BundleDowngrade.yaml` file and remove the old one for the downgrade tests
7576
7677
## Updating Kafka Bridge version
7778
@@ -81,7 +82,8 @@ If you need to update the Kafka bridge to newer version, you should do it with f
8182
8283
1. Edit the `bridge.version` file and update it to contain the new Bridge version
8384
2. Run `make bridge_version` to update the related files to the new version
84-
3. Commit all modified files to Git and open a PR.
85+
3. Update the `BridgeVersion` variable in the `documentation/shared/attributes.adoc` file.
86+
4. Commit all modified files to Git and open a PR.
8587
8688
## Running Azure System Tests pipelines
8789

0 commit comments

Comments
 (0)