Add release document into repository - #69
Conversation
Signed-off-by: see-quick <maros.orsak159@gmail.com>
scholzj
left a comment
There was a problem hiding this comment.
I left some comments. But to be honest, it seems rather lengthy and hard to follow. Instead of explaning the steps, it focus on commands which are semi-useless because they would not work for me. It is also completely missing the human part of the process we expect ... such as focus on the announcements, community testing, on some real (manual and/or exploratory) testing rather than 100% reliance on automated checks.
|
|
||
| Create a release branch in **both** repositories: | ||
|
|
||
| ```bash |
There was a problem hiding this comment.
Should we just explain the branch name rather than provide command to copy with hardcoded remote names and directory names (in my case for example they are all different in practice, so the commands would be useless).
There was a problem hiding this comment.
I would stick with the commands since they make it explicit what needs to be done, instead of relying on descriptive text.
I understand the concern about hardcoded remotes but if really neeeded , I can make it more generic it but overall I think the commands alone are enough for the reader to understand the intended approach.
There was a problem hiding this comment.
I don't know. The problem with the commands is that they will not work for most people. So they are not really self explanatory in my opinion.
There was a problem hiding this comment.
Adding info about how the versioning works is definitely worthy
Signed-off-by: see-quick <maros.orsak159@gmail.com>
I will think about this and update the PR when I find more time. |
Signed-off-by: see-quick <maros.orsak159@gmail.com>
Frawless
left a comment
There was a problem hiding this comment.
I think adding some short summary on the beggining of the doc might be useful as well? Like you will need to do this, this this, the detailed steps are the following... I understand this is quite complicated to make it released, but it is also not that simple to stay focused on the guide and short overview might improve it.
|
|
||
| Create a release branch in **both** repositories: | ||
|
|
||
| ```bash |
There was a problem hiding this comment.
Adding info about how the versioning works is definitely worthy
Signed-off-by: see-quick <maros.orsak159@gmail.com>
Updated. |
Signed-off-by: see-quick <maros.orsak159@gmail.com>
|
Let me know what you think @scholzj @Frawless.
How do you see this? In |
| RELEASE_VERSION=0.116.0 make release_maven release_json | ||
|
|
||
| git add pom.xml src/main/resources/kafka_versions.json | ||
| git commit -m "Set version to 0.116.0" |
There was a problem hiding this comment.
| git commit -m "Set version to 0.116.0" | |
| git commit -s -m "Set version to 0.116.0" |
| ```bash | ||
| git checkout release-0.116.x | ||
| git cherry-pick <commit-hash> | ||
| git push upstream release-0.116.x |
There was a problem hiding this comment.
| git push upstream release-0.116.x | |
| git push <repository> release-0.116.x |
| # test-container-images | ||
| git checkout release-0.116.x | ||
| git tag 0.116.0-rc1 | ||
| git push upstream 0.116.0-rc1 |
There was a problem hiding this comment.
| git push upstream 0.116.0-rc1 | |
| git push <repository> 0.116.0-rc1 |
| cd ../test-container | ||
| git checkout release-0.116.x | ||
| git tag 0.116.0-rc1 | ||
| git push upstream 0.116.0-rc1 |
There was a problem hiding this comment.
| git push upstream 0.116.0-rc1 | |
| git push <repository> 0.116.0-rc1 |
| # test-container-images | ||
| git checkout release-0.116.x | ||
| git tag 0.116.0 | ||
| git push upstream 0.116.0 |
There was a problem hiding this comment.
| git push upstream 0.116.0 | |
| git push <repository> 0.116.0 |
| cd ../test-container | ||
| git checkout release-0.116.x | ||
| git tag 0.116.0 | ||
| git push upstream 0.116.0 |
There was a problem hiding this comment.
| git push upstream 0.116.0 | |
| git push <repository> 0.116.0 |
| - Verify the GA images are available on [Quay.io](https://quay.io/organization/strimzi-test-container) | ||
| - Verify the Maven artifact is available on [Maven Central](https://central.sonatype.com/artifact/io.strimzi/strimzi-test-container) | ||
| - Create GitHub releases in both repositories | ||
| - Bump the SNAPSHOT version on `main` in `strimzi/test-container` if needed |
There was a problem hiding this comment.
This is ideally somehting to do when you branch the release. Since fomr then on the main branch build might container things that will never reach the GA (so 0.5.0-SNAPSHOT might have things that never make the 0.5.0)
| git push upstream 0.116.0 | ||
| ``` | ||
|
|
||
| ### 8. Post-release |
There was a problem hiding this comment.
Should the announcement be here as well? Maybe also suggest to open PRs for our own repos using the test container?
Type of change
Description
This PR adds a release document to this repositorty. I reviewed it multiple times, so hopefully I didn't miss anything. Also as we need to always release both test-container and test-container-images repos I decided to put release documentation here ... as release process starts here. And then I can reference this document in the test-container repository.
Checklist