Skip to content
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.

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

📖 doc: add release cycle doc #7391

Merged
merged 1 commit into from
Oct 21, 2022

Conversation

sbueringer
Copy link
Member

Signed-off-by: Stefan Büringer [email protected]

What this PR does / why we need it:
Hey folks,
this is the follow-up from the discussion during the office hours today.

The dates are preliminary but I think it it's good to have some specific dates already that we can move +/- a day or two if necessary.

The timeline is inspired by the Kubernetes timeline here (https://github.com/kubernetes/sig-release/blob/master/releases/release-1.26/README.md). They have a lot more dates in their timeline, but I think we should start small and then the first release team can add more dates (e.g. for things like writing release notes). But I think we also don't have to over-formalize it for now and define dates for everything

Which issue(s) this PR fixes (optional, in fixes #<issue number>(, fixes #<issue_number>, ...) format, will close the issue(s) when PR gets merged):
Part of #7389

@k8s-ci-robot k8s-ci-robot added cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. size/M Denotes a PR that changes 30-99 lines, ignoring generated files. labels Oct 11, 2022
Copy link
Contributor

@alexander-demicev alexander-demicev left a comment

Choose a reason for hiding this comment

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

great description of the release cycle!

docs/developer/release-cycle.md Outdated Show resolved Hide resolved
@enxebre
Copy link
Member

enxebre commented Oct 12, 2022

Thanks for putting this together Stefan

@sbueringer
Copy link
Member Author

Thx for the reviews everyone!

Fixed some findings, answered on others.

Copy link
Member

@fabriziopandini fabriziopandini left a comment

Choose a reason for hiding this comment

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

@sbueringer thanks for pushing this forward, really appreciated.
I have added a couple of comments/suggestions trying to clarify some points about what happens on main vs what happens on the release branch, but this is a great start!

docs/developer/release-cycle.md Outdated Show resolved Hide resolved
docs/developer/release-cycle.md Outdated Show resolved Hide resolved
docs/developer/release-cycle.md Outdated Show resolved Hide resolved
docs/developer/release-cycle.md Outdated Show resolved Hide resolved
docs/developer/release-cycle.md Outdated Show resolved Hide resolved
docs/developer/release-cycle.md Outdated Show resolved Hide resolved
docs/developer/release-cycle.md Outdated Show resolved Hide resolved
docs/developer/release-cycle.md Outdated Show resolved Hide resolved
docs/developer/release-cycle.md Show resolved Hide resolved
@sbueringer
Copy link
Member Author

Thx for the feedback!

Pushed another version

@sbueringer
Copy link
Member Author

Hey folks,
just a general PSA, we would aim to merge this document until end of next week (before KubeCon) if no blocking issues are coming up. Just to have the dates finalized.
(as discussed in the office hours)

@sbueringer sbueringer force-pushed the add-release-cycle-doc branch from 316818d to ad474a3 Compare October 12, 2022 18:40
@sbueringer
Copy link
Member Author

/retest

Copy link
Member

@furkatgofurov7 furkatgofurov7 left a comment

Choose a reason for hiding this comment

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

Thanks for putting this together @sbueringer! Some nits inline:

docs/developer/release-cycle.md Outdated Show resolved Hide resolved
docs/developer/release-cycle.md Outdated Show resolved Hide resolved
Copy link
Member

@furkatgofurov7 furkatgofurov7 left a comment

Choose a reason for hiding this comment

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

One question I forgot to mention earlier: Looking through the k8s timeline doc, noticed they had a weekly meeting minutes (and a separate google doc) dedicated to the release team. Are we also planning to have one as well and if so, does it worth mentioning it in this document?

@k8s-ci-robot k8s-ci-robot added size/L Denotes a PR that changes 100-499 lines, ignoring generated files. and removed size/M Denotes a PR that changes 30-99 lines, ignoring generated files. labels Oct 13, 2022
@sbueringer
Copy link
Member Author

sbueringer commented Oct 13, 2022

And pushed another version :)

One question I forgot to mention earlier: Looking through the k8s timeline doc, noticed they had a weekly meeting minutes (and a separate google doc) dedicated to the release team. Are we also planning to have one as well and if so, does it worth mentioning it in this document?

I think if we choose to have one as well it would be great to have it here. Essentially to have this as a landing page like they have it in upstream (~ https://github.com/kubernetes/sig-release/tree/master/releases/release-1.26). If this page gets to big we can also split it up in one per-release.

As we didn't discuss/decide yet how the release team organizes itself I would wait for that and then the page can be adjusted accordingly. I'll make a note in the umbrella issue that we have to figure out how the release team coordinates itself / the working model of the release team.

@VibhorChinda
Copy link
Contributor

Thanks @sbueringer for putting this together :))
The document content looks good to me.

One thought should we go into more modular approach like done for the Kubernetes release repository link

Something I tried to sketch out, please have a look.
Release Process Docs Cluster Api

The thought behind this approach was to keep process smoother in later releases because like adding timelines for all cycles in one document like above will keep increasing the document too much I feel.

Open for everyone's suggestion :))

@sbueringer
Copy link
Member Author

sbueringer commented Oct 13, 2022

@VibhorChinda I think you're suggestion is fine. I just wanted to keep it in one doc for the start and we can split it up later when we add more.

As of today we just don't have the same complexity as Kubernetes has and I would want to wait and see if we actually get to that or even need it. (just looking at all the docs they have...)

@VibhorChinda
Copy link
Contributor

@VibhorChinda I think you're suggestion is fine. I just wanted to keep it in one doc for the start and we can split it up later when we add more.

As of today we just don't have the same complexity as Kubernetes has and I would want to wait and see if we actually get to that or even need it. (just looking at all the docs they have...)

Understood 👍🏻 :))

Copy link
Contributor

@ykakarap ykakarap left a comment

Choose a reason for hiding this comment

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

The document is great!

Thank you for doing this :)

docs/developer/release-cycle.md Show resolved Hide resolved
docs/developer/release-cycle.md Outdated Show resolved Hide resolved
docs/developer/release-cycle.md Outdated Show resolved Hide resolved
docs/developer/release-cycle.md Outdated Show resolved Hide resolved
docs/developer/release-cycle.md Outdated Show resolved Hide resolved
Copy link
Member

@fabriziopandini fabriziopandini left a comment

Choose a reason for hiding this comment

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

One last nit from my side, otherwise lgtm
This is a great start!

docs/developer/release-cycle.md Show resolved Hide resolved
@sbueringer
Copy link
Member Author

And another version :)

@fabriziopandini
Copy link
Member

/lgtm

@k8s-ci-robot k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Oct 17, 2022
Copy link
Contributor

@CecileRobertMichon CecileRobertMichon left a comment

Choose a reason for hiding this comment

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

/lgtm

@sbueringer sbueringer force-pushed the add-release-cycle-doc branch from 3ec0465 to 36e7574 Compare October 17, 2022 16:50
@k8s-ci-robot k8s-ci-robot removed the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Oct 17, 2022
@sbueringer
Copy link
Member Author

(just updated the v1.2.x releases now that we did an additional v1.2.4 bug-fix release)

@fabriziopandini
Copy link
Member

/lgtm

@k8s-ci-robot k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Oct 17, 2022
Signed-off-by: Stefan Büringer [email protected]
@sbueringer
Copy link
Member Author

Squashed

@sbueringer sbueringer force-pushed the add-release-cycle-doc branch from 36e7574 to 9439cdd Compare October 18, 2022 11:02
@k8s-ci-robot k8s-ci-robot removed the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Oct 18, 2022
@sbueringer
Copy link
Member Author

@CecileRobertMichon @fabriziopandini I would merge on Friday? (not EOD :))

@fabriziopandini
Copy link
Member

/lgtm
+1 to merge Friday if no short stoppers pops up

@k8s-ci-robot k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Oct 19, 2022
@vincepri
Copy link
Member

vincepri commented Oct 19, 2022

/approve
/hold
until Friday Oct 21st to merge, pending last minute comments

@k8s-ci-robot k8s-ci-robot added the do-not-merge/hold Indicates that a PR should not merge because someone has issued a /hold command. label Oct 19, 2022
@k8s-ci-robot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: vincepri

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

@k8s-ci-robot k8s-ci-robot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Oct 19, 2022
@sbueringer
Copy link
Member Author

/hold cancel

@k8s-ci-robot k8s-ci-robot removed the do-not-merge/hold Indicates that a PR should not merge because someone has issued a /hold command. label Oct 21, 2022
@k8s-ci-robot k8s-ci-robot merged commit a11dcc8 into kubernetes-sigs:main Oct 21, 2022
@k8s-ci-robot k8s-ci-robot added this to the v1.3 milestone Oct 21, 2022
@sbueringer sbueringer deleted the add-release-cycle-doc branch October 21, 2022 10:36
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
approved Indicates a PR has been approved by an approver from all required OWNERS files. cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. lgtm "Looks good to me", indicates that a PR is ready to be merged. size/L Denotes a PR that changes 100-499 lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

10 participants