Skip to content

Add release document into repository - #69

Open
see-quick wants to merge 5 commits into
strimzi:mainfrom
see-quick:add-release-process
Open

Add release document into repository#69
see-quick wants to merge 5 commits into
strimzi:mainfrom
see-quick:add-release-process

Conversation

@see-quick

@see-quick see-quick commented Jun 12, 2026

Copy link
Copy Markdown
Member

Type of change

  • Documentation

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

  • Update documentation
  • Update CHANGELOG.md (if present)
  • Reference relevant issue(s) and close them after merging
  • Write tests
  • Make sure all tests pass
  • Try your changes inside a Kubernetes cluster, not just from unit tests
  • AI assistance was used to create this PR (see the Strimzi AI policy)

Signed-off-by: see-quick <maros.orsak159@gmail.com>
@see-quick see-quick added this to the 0.117.0 milestone Jun 12, 2026
@see-quick
see-quick requested a review from a team June 12, 2026 10:33
@see-quick see-quick self-assigned this Jun 12, 2026
@see-quick see-quick added the documentation Improvements or additions to documentation label Jun 12, 2026

@scholzj scholzj left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Comment thread RELEASE.md Outdated
Comment thread RELEASE.md Outdated
Comment thread RELEASE.md Outdated
Comment thread RELEASE.md Outdated

Create a release branch in **both** repositories:

```bash

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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).

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Adding info about how the versioning works is definitely worthy

Comment thread RELEASE.md
Comment thread RELEASE.md Outdated
Comment thread RELEASE.md Outdated
Signed-off-by: see-quick <maros.orsak159@gmail.com>
@see-quick

Copy link
Copy Markdown
Member Author

such as focus on the announcements, community testing, on some real (manual and/or exploratory) testing rather than 100% reliance on automated checks.

I will think about this and update the PR when I find more time.

Signed-off-by: see-quick <maros.orsak159@gmail.com>

@Frawless Frawless left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Comment thread RELEASE.md Outdated

Create a release branch in **both** repositories:

```bash

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Adding info about how the versioning works is definitely worthy

Comment thread RELEASE.md
Signed-off-by: see-quick <maros.orsak159@gmail.com>
@see-quick

Copy link
Copy Markdown
Member Author

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.

Updated.

Signed-off-by: see-quick <maros.orsak159@gmail.com>
@see-quick

Copy link
Copy Markdown
Member Author

Let me know what you think @scholzj @Frawless.

such as focus on the announcements, community testing, on some real (manual and/or exploratory) testing rather than 100% reliance on automated checks.

I will think about this and update the PR when I find more time.

How do you see this? In 5. Release RC of test-container, there is already a note describing what to do after building the RC and where it should be announced.

Comment thread RELEASE.md
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"

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
git commit -m "Set version to 0.116.0"
git commit -s -m "Set version to 0.116.0"

Comment thread RELEASE.md
```bash
git checkout release-0.116.x
git cherry-pick <commit-hash>
git push upstream release-0.116.x

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
git push upstream release-0.116.x
git push <repository> release-0.116.x

Comment thread RELEASE.md
# test-container-images
git checkout release-0.116.x
git tag 0.116.0-rc1
git push upstream 0.116.0-rc1

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
git push upstream 0.116.0-rc1
git push <repository> 0.116.0-rc1

Comment thread RELEASE.md
cd ../test-container
git checkout release-0.116.x
git tag 0.116.0-rc1
git push upstream 0.116.0-rc1

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
git push upstream 0.116.0-rc1
git push <repository> 0.116.0-rc1

Comment thread RELEASE.md
# test-container-images
git checkout release-0.116.x
git tag 0.116.0
git push upstream 0.116.0

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
git push upstream 0.116.0
git push <repository> 0.116.0

Comment thread RELEASE.md
cd ../test-container
git checkout release-0.116.x
git tag 0.116.0
git push upstream 0.116.0

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
git push upstream 0.116.0
git push <repository> 0.116.0

Comment thread RELEASE.md
- 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

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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)

Comment thread RELEASE.md
git push upstream 0.116.0
```

### 8. Post-release

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should the announcement be here as well? Maybe also suggest to open PRs for our own repos using the test container?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants