Improvements to release docs #11606
Merged
Improvements to release docs #11606
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Signed-off-by: Katherine Stanley <11195226+katheris@users.noreply.github.com>
katheris
commented
Jun 30, 2025
| @@ -13,44 +13,45 @@ The release process should normally look like this: | |||
| 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. | |||
| 2. On the `main` git branch of the repository: | |||
| * 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`. | |||
| * 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. | |||
| * Add a header for the new release to the `CHANGELOG.md` file | |||
| * 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 the to one you are releasing by setting the `ProductVersionPrevious` variable. | |||
There was a problem hiding this comment.
Clarified wording based on my understanding to make it clearer
katheris
commented
Jun 30, 2025
| 4. Use the `RELEASE_VERSION` environment variable to set the desired version | ||
| * Use always the GA version here (e.g. `0.45.0`) and not the RC version (e.g `0.45.0-rc1`) | ||
| 5. Run `RELEASE_VERSION=<desired version> make release`, for example `RELEASE_VERSION=0.45.0 make release` | ||
| 4. Run `RELEASE_VERSION=<desired version> make release`, for example `RELEASE_VERSION=0.45.0 make release` |
There was a problem hiding this comment.
I ran export RELEASE_VERSION then realised the next step included the env var, so I think this would be clearer as one step
katheris
commented
Jun 30, 2025
| * This will automatically update several `pom.xml` files and all files in `packaging/`, `install/`, `example/` and `helm-charts/` folders. | ||
| 6. Update the checksums for released files in `.checksums` in the release branch | ||
| * Use the Make commands `make checksum_examples`, `make checksum_install`, and `make checksum_helm` to generate the new checksums | ||
| 5. Update the checksums for released files in `.checksums` in the release branch |
There was a problem hiding this comment.
Reordered commands to match order in the file
katheris
commented
Jun 30, 2025
| * Set the desired release version (e.g. `0.45.0-rc1` for RCs or `0.45.0` GA releases) | ||
| * Set the release suffix as `0` | ||
| * Set the build ID to the build ID from previous step (For GA, this should be the build ID used for the last RC since there should be no changes) | ||
| * Set the `CENTRAL_USERNAME` and `CENTRAL_PASSWORD` variables to your Maven Central user token |
There was a problem hiding this comment.
Added step to set Maven central token now we moved away from sonatype
katheris
commented
Jun 30, 2025
| * Download the release artifacts (binary, documentation and sbom) | ||
| * Check the images pushed to Quay.io | ||
| * Mark the build in the Azure Pipelines UI to be retained forever | ||
| 12. Create a GitHub tag and release based on the release branch. Attach the release artifacts and docs as downloaded from the Azure pipelines. | ||
| * Go to Maven Central > Publish and publish the release artifacts |
There was a problem hiding this comment.
Add step to publish in sonatype
katheris
commented
Jun 30, 2025
| * Update the documentation: | ||
| * Create new directories `docs/operators/<new-version>` and `docs/operators/<new-version>/full` in the website repository | ||
| * Copy files from the operators repository `documentation/htmlnoheader` to `docs/operators/<new-version>` in the website repository | ||
| * Copy files from the operators repository `documentation/html` to `docs/operators/<new-version>/full` in the website repository | ||
| * Delete the old HTML files and images from `docs/operators/latest` and `docs/operators/latest/full` (keep the `*.md` files) |
There was a problem hiding this comment.
I used the release artifact here, since it's needed for the helm command it worked well, but correct me if this is wrong
katheris
commented
Jun 30, 2025
| 15. _(only for GA, not for RCs)_ On the `main` git branch of the repository: | ||
| * Update the `ProductVersion` variable in `documentation/shared/attributes.adoc` | ||
| 14. _(only for GA, not for RCs)_ On the `main` git branch of the repository: | ||
| * Check the `ProductVersion` variable is correct in `documentation/shared/attributes.adoc` |
There was a problem hiding this comment.
This is already done in an earlier step
katheris
commented
Jun 30, 2025
scholzj
reviewed
Jun 30, 2025
ppatierno
approved these changes
Jul 1, 2025
scholzj
approved these changes
Jul 3, 2025
im-konge
approved these changes
Jul 3, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Type of change
Select the type of your PR
Description
Improvements to release docs based on my experience doing the release for the first time
Checklist
Please go through this checklist and make sure all applicable tasks have been done