Skip to content

Write a release document #400

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Open
wants to merge 3 commits into
base: release-1.0
Choose a base branch
from
Open

Write a release document #400

wants to merge 3 commits into from

Conversation

kannon92
Copy link
Contributor

No description provided.

@openshift-ci OpenShift CI
Copy link

openshift-ci bot commented Jun 24, 2025

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: kannon92

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@openshift-ci openshift-ci bot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Jun 24, 2025
@kannon92 kannon92 changed the base branch from release-1.0 to main July 17, 2025 19:33
@kannon92 kannon92 changed the base branch from main to release-1.0 July 17, 2025 19:33
@kannon92
Copy link
Contributor Author

/retest

MaysaMacedo
MaysaMacedo reviewed Jul 21, 2025
View reviewed changes
docs/RELEASE.md Outdated

### EnterpriseContractPolicy

The ECP is a policy that verifies application defined policities and tests if the images pass these policies.
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
The ECP is a policy that verifies application defined policities and tests if the images pass these policies.
The ECP is a policy that verifies application defined policies and tests if the images pass these policies.

docs/RELEASE.md
To release, it is necessary to understand ReleasePlanAdmissions (RPA), EnterpriseContractPolicy (ECP), ReleasePlans (RP), Releases and Snapshots.
You can find these definitions in konflux-release-data in our internal gitlab.

A VPN is required for these links but you can find the definitions [here](https://gitlab.cee.redhat.com/releng/konflux-release-data).
Copy link
Contributor

Choose a reason for hiding this comment

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

might worth pointing to the exact place in the code where to find them

Copy link
Contributor Author

Choose a reason for hiding this comment

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

good idea.

docs/RELEASE.md Outdated

ReleasePlanAdmissions control the tagging of the images and where they are promoted when released.
These objects also control what ECP runs on a release.
Each release of Kueue will need a new RPA so that one can change the tagging of our images.
Copy link
Contributor

Choose a reason for hiding this comment

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

If that is not needed in minor releases:

Suggested change
Each release of Kueue will need a new RPA so that one can change the tagging of our images.
Each major release of Kueue will need a new RPA so that one can change the tagging of our images.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Its actually minor..

I think semvar says (major.minor.patch) so 1.0 and 1.1 are minor bumps. And 1.0.1 would be a patch release.

docs/RELEASE.md
### Release

This is a manual CR that triggers the release.
You must specify the snapshot of the intended product you want to release.
Copy link
Contributor

Choose a reason for hiding this comment

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

Is it worth adding a link to where find the snapshot?

docs/RELEASE.md
...
```

One adds release notes to this YAML based on the release.
Copy link
Contributor

Choose a reason for hiding this comment

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

Might be worth adding the link to the konflux page that explains it
https://konflux.pages.redhat.com/docs/users/releasing/create-release.html#creating-a-release-object
and maybe some other page that gives more details of data field

docs/RELEASE.md

To release Red Hat Build of Kueue:

1. Release the Kueue Operand.
Copy link
Contributor

Choose a reason for hiding this comment

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

we also need to bump the operator version as well, right?
like #467

docs/RELEASE.md Outdated
1. Release the Kueue Operand.
2. Update the operator bundle to use release operand images.
3. Release the Kueue Operator.
4. Update the fbc to use the released bundle image.
Copy link
Contributor

Choose a reason for hiding this comment

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

could we mention where to get that image?

docs/RELEASE.md

One updates the [catalog-template](https://github.com/openshift/kueue-fbc/pull/16/files) and runs generate-fbc.sh.

Once the fbc merges, you must create a Release for the FBC.
Copy link
Contributor

Choose a reason for hiding this comment

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

Is this done with the Release CR?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Correct.

MaysaMacedo
MaysaMacedo reviewed Jul 21, 2025
View reviewed changes
docs/RELEASE.md Outdated

For 1.0, it is based on Kueue 0.11.

Kueue is based on the release branch and 0.11 so the application is kueue-0-11.
Copy link
Contributor

Choose a reason for hiding this comment

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

Is this about openshift release branch or kubernetes release branch?

@openshift-ci OpenShift CI
Copy link

openshift-ci bot commented Jul 24, 2025

@kannon92: The following tests failed, say /retest to rerun all failed tests or /retest-required to rerun all mandatory failed tests:

Test name Commit Details Required Rerun command
ci/prow/test-e2e-4-18 289d48e link true /test test-e2e-4-18
ci/prow/test-e2e-4-17 289d48e link false /test test-e2e-4-17
ci/prow/test-e2e-4-19 289d48e link true /test test-e2e-4-19

Full PR test history. Your PR dashboard.

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository. I understand the commands that are listed here.

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

@rphillips rphillips Awaiting requested review from rphillips

@sohankunkerkar sohankunkerkar Awaiting requested review from sohankunkerkar

1 more reviewer

@MaysaMacedo MaysaMacedo MaysaMacedo left review comments

Reviewers whose approvals may not affect merge requirements
Assignees
No one assigned
Labels
approved Indicates a PR has been approved by an approver from all required OWNERS files.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@kannon92 @MaysaMacedo