Adjust the releases process documentation. #10727

VannTen · 2023-12-18T09:25:59Z

What type of PR is this?
/kind documentation

What this PR does / why we need it:

markdown numbered lists: no need to manually maitain the numbers
add instructions to update the collection version roughly following
Ansible collection maintenance guidelines
(https://docs.ansible.com/ansible/latest/community/collection_contributors/collection_release_with_branches.html)
Distinguish major from minor releases in the release process
Bump current galaxy.yml version to the next release

Which issue(s) this PR fixes:

Special notes for your reviewer:

Does this PR introduce a user-facing change?:

kubespray used as a collection will have the correct collection version

/assign @yankay

I also wonder if we should create an issue template for release, with a checklist for all the things in the list ?

yankay · 2023-12-18T09:29:19Z

RELEASE.md

+1. Create the release note with [Kubernetes Release Notes Generator](https://github.com/kubernetes/release/blob/master/cmd/release-notes/README.md). See the following `Release note creation` section for the details.
+1. An approver creates [new release in GitHub](https://github.com/kubernetes-sigs/kubespray/releases/new) using a version and tag name like `vX.Y.Z` and attaching the release notes
+1. (Only for major releases) An approver creates a release branch in the form `release-X.Y`
+1. (Only for major releases) On the `master` branch: bump the version in `galaxy.yml` to the next expected major release (X.y.0 with y = Y + 1), commit and push.


HI @VannTen

The galaxy.yml should be changed just before

1. An approver creates [new release in GitHub](https://github.com/kubernetes-sigs/kubespray/releases/new) using a version and tag name like `vX.Y.Z` and attaching the release notes

So that the galaxy.yml is the same as with tag vX.Y.Z.

And it change be changed to :

1. Ensure the version in `galaxy.yml` is the next expected major release (X.y.0 with y = Y + 1); if not, please bump it.

Thanks :-)

Well, I was reusing the Ansible guidelines ; the idea being that as soon as we cut a new release, the very next thing we do is increment the version number (aka galaxy.yml version should match KUBESPRAY_NEXT_VERSION).
I think that way it would be harder to release with the wrong version, since it's checked by CI during all the time.

Thanks , I got it :-)

How do you think about changing the commit and push. to create a bump PR for it

I don't have a strong opinion on that part. The one downside I can see for that is that it kinda breaks the workflow of doing a release (since you have to make a PR and get a lgtm for what is a really trivial change).
It's not that bad ofc, so I can change it if you like

Ideally we would have automation for that (prow creating a PR for updating the version number whenever it sees a releases), but well, we don't have that currently ^.

Also if we go with that we'd have to use KUBESPRAY_NEXT_VERSION instead of KUBEPRAY_VERSION in the check-galaxy script

The idea of automation is great, though we need to do it manually.👍
And the PR is better than a push because it can make the process more transparent :-)

I don't have a strong opinion on that part. The one downside I can see for that is that it kinda breaks the workflow of doing a release (since you have to make a PR and get a lgtm for what is a really trivial change). It's not that bad ofc, so I can change it if you like

Ideally we would have automation for that (prow creating a PR for updating the version number whenever it sees a releases), but well, we don't have that currently ^.

Also, if we go with that, we'd have to use KUBESPRAY_NEXT_VERSION instead of KUBEPRAY_VERSION in the check-galaxy script

I agree with you; the CI code needs to be changed :-)
BTW, does the KUBESPRAY_NEXT_VERSION, KUBESPRAY_VERSION,andgalaxy.yml` be changed together better?

Thank you

Yeah good point I'll add that to the docs as well 👍

Hum
I'm trying to refactor the check-galaxy version to have it check the next expected version, unfortunately it's not that easy since we don't have access to the target MR branch (so can't distinguish between minor/major....) 🤔

yankay · 2023-12-18T09:30:46Z

galaxy.yml

@@ -2,7 +2,7 @@
 namespace: kubernetes_sigs
 description: Deploy a production ready Kubernetes cluster
 name: kubespray
-version: 2.23.1
+version: 2.24.0
 readme: README.md


Hi @VannTen

It maybe better to use another PR to modify.
Because the PR is for docs changes :-)

yankay · 2023-12-18T09:36:06Z

RELEASE.md

+1. An approver creates [new release in GitHub](https://github.com/kubernetes-sigs/kubespray/releases/new) using a version and tag name like `vX.Y.Z` and attaching the release notes
+1. (Only for major releases) An approver creates a release branch in the form `release-X.Y`
+1. (Only for major releases) On the `master` branch: bump the version in `galaxy.yml` to the next expected major release (X.y.0 with y = Y + 1), commit and push.
+1. On the `release-X.Y` branch: bump the version in `galaxy.yml` to the next expected minor release (X.Y.z with z = Z + 1), commit and push.


~~If the galaxy.yml can be ensured just before the tag, the line can be removed :-)~~

* markdown numbered lists: no need to manually maitain the numbers * add instructions to update the collection version roughly following Ansible collection maintenance guidelines (https://docs.ansible.com/ansible/latest/community/collection_contributors/collection_release_with_branches.html) * Distinguish major from minor releases in the release process * Bump current galaxy.yml version to the next release

yankay · 2024-01-11T11:30:54Z

Thanks @VannTen
/approve

VannTen · 2024-01-11T14:33:22Z

/cc @floryut
wdyt ?

VannTen · 2024-01-11T15:45:50Z

/cc @MrFreezeex
as well

MrFreezeex · 2024-01-11T15:58:08Z

I'm not very familiar with the release process so I will let people that may do it check TBH.

yankay · 2024-01-17T03:39:49Z

HI @floryut @oomichi

Would you please help to review the changes :-)
Thank you

floryut

HI @floryut @oomichi

Would you please help to review the changes :-)
Thank you

All good for me 👍
Thank you @VannTen

k8s-ci-robot · 2024-01-22T15:58:49Z

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: floryut, VannTen, yankay

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:

~~OWNERS~~ [floryut,yankay]

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

floryut · 2024-01-22T16:02:35Z

/lgtm

* markdown numbered lists: no need to manually maitain the numbers * add instructions to update the collection version roughly following Ansible collection maintenance guidelines (https://docs.ansible.com/ansible/latest/community/collection_contributors/collection_release_with_branches.html) * Distinguish major from minor releases in the release process * Bump current galaxy.yml version to the next release

k8s-ci-robot assigned yankay Dec 18, 2023

k8s-ci-robot added the kind/documentation Categorizes issue or PR as related to documentation. label Dec 18, 2023

k8s-ci-robot requested a review from holmsten December 18, 2023 09:26

k8s-ci-robot added the cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. label Dec 18, 2023

k8s-ci-robot requested a review from oomichi December 18, 2023 09:26

k8s-ci-robot added the size/S Denotes a PR that changes 10-29 lines, ignoring generated files. label Dec 18, 2023

yankay reviewed Dec 18, 2023

View reviewed changes

VannTen force-pushed the doc/galaxy_yml_releases branch 2 times, most recently from 23b088e to 046d804 Compare December 18, 2023 11:01

VannTen mentioned this pull request Dec 18, 2023

Refactor check_galaxy + fix version #10729

Merged

VannTen force-pushed the doc/galaxy_yml_releases branch from 046d804 to 37f4329 Compare December 19, 2023 09:36

k8s-ci-robot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Jan 11, 2024

k8s-ci-robot requested a review from floryut January 11, 2024 14:33

k8s-ci-robot requested a review from MrFreezeex January 11, 2024 15:45

floryut approved these changes Jan 22, 2024

View reviewed changes

k8s-ci-robot assigned floryut Jan 22, 2024

k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Jan 22, 2024

k8s-ci-robot merged commit 4e52fb7 into kubernetes-sigs:master Jan 22, 2024
64 checks passed

mzaian mentioned this pull request Apr 26, 2024

Release Proposal v2.25 #11126

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Adjust the releases process documentation. #10727

Adjust the releases process documentation. #10727

VannTen commented Dec 18, 2023

yankay Dec 18, 2023 •

edited

Loading

VannTen Dec 18, 2023

yankay Dec 18, 2023 •

edited

Loading

VannTen Dec 18, 2023

VannTen Dec 18, 2023

yankay Dec 18, 2023 •

edited

Loading

yankay Dec 18, 2023 •

edited

Loading

VannTen Dec 18, 2023

VannTen Dec 18, 2023

yankay Dec 18, 2023

yankay Dec 18, 2023 •

edited

Loading

yankay commented Jan 11, 2024

VannTen commented Jan 11, 2024

VannTen commented Jan 11, 2024

MrFreezeex commented Jan 11, 2024

yankay commented Jan 17, 2024

floryut left a comment

k8s-ci-robot commented Jan 22, 2024

floryut commented Jan 22, 2024

Adjust the releases process documentation. #10727

Adjust the releases process documentation. #10727

Conversation

VannTen commented Dec 18, 2023

yankay Dec 18, 2023 • edited Loading

Choose a reason for hiding this comment

VannTen Dec 18, 2023

Choose a reason for hiding this comment

yankay Dec 18, 2023 • edited Loading

Choose a reason for hiding this comment

VannTen Dec 18, 2023

Choose a reason for hiding this comment

VannTen Dec 18, 2023

Choose a reason for hiding this comment

yankay Dec 18, 2023 • edited Loading

Choose a reason for hiding this comment

yankay Dec 18, 2023 • edited Loading

Choose a reason for hiding this comment

VannTen Dec 18, 2023

Choose a reason for hiding this comment

VannTen Dec 18, 2023

Choose a reason for hiding this comment

yankay Dec 18, 2023

Choose a reason for hiding this comment

yankay Dec 18, 2023 • edited Loading

Choose a reason for hiding this comment

yankay commented Jan 11, 2024

VannTen commented Jan 11, 2024

VannTen commented Jan 11, 2024

MrFreezeex commented Jan 11, 2024

yankay commented Jan 17, 2024

floryut left a comment

Choose a reason for hiding this comment

k8s-ci-robot commented Jan 22, 2024

floryut commented Jan 22, 2024

yankay Dec 18, 2023 •

edited

Loading

yankay Dec 18, 2023 •

edited

Loading

yankay Dec 18, 2023 •

edited

Loading

yankay Dec 18, 2023 •

edited

Loading

yankay Dec 18, 2023 •

edited

Loading