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

📖 Update CAPI support and guarantees for v1.6 #9119

Merged
merged 1 commit into from
Aug 9, 2023

Conversation

g-gaston
Copy link
Contributor

@g-gaston g-gaston commented Aug 3, 2023

Completing the release comms task for this week.

@kubernetes-sigs/cluster-api-release-team

/area documentation

@k8s-ci-robot
Copy link
Contributor

@g-gaston: The label(s) area/docs cannot be applied, because the repository doesn't have them.

In response to this:

Completing the release comms task for this week.

@kubernetes-sigs/cluster-api-release-team

/area docs

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/test-infra repository.

@k8s-ci-robot k8s-ci-robot added the cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. label Aug 3, 2023
@k8s-ci-robot k8s-ci-robot added the size/L Denotes a PR that changes 100-499 lines, ignoring generated files. label Aug 3, 2023
@g-gaston
Copy link
Contributor Author

g-gaston commented Aug 3, 2023

/area documentation

@k8s-ci-robot k8s-ci-robot added the area/documentation Issues or PRs related to documentation label Aug 3, 2023
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 PR, few suggestions inline:

CONTRIBUTING.md Show resolved Hide resolved
CONTRIBUTING.md Outdated
@@ -2,35 +2,36 @@
<!-- START doctoc generated TOC please keep comment here to allow auto update -->
<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->

- [Contributor License Agreements](#contributor-license-agreements)
Copy link
Member

Choose a reason for hiding this comment

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

@g-gaston this is correct, can you please update the release-task.md with the notes that we need to update this file as well?

Copy link
Member

Choose a reason for hiding this comment

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

Which change do you mean? The table of contents or the one below with EOL?

EOL is already documented

  1. For minor releases Set EOL date for previous release (prior art: 📖 book: set v1.1.x EOL date #7146) and update Cluster API support and guarantees in CONTRIBUTING.md (prior art: 📖 docs: update CAPI support and guarantees #8308).

Copy link
Member

@sbueringer sbueringer Aug 4, 2023

Choose a reason for hiding this comment

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

I think this usually included adding the new release as well (see https://github.com/kubernetes-sigs/cluster-api/pull/8308/files?diff=split&w=1)

Copy link
Member

Choose a reason for hiding this comment

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

@sbueringer I meant the table in this file with release/API version/Supported until notes. Because currently, there is no mention of the need for updating this file in the release-tasks.md

Copy link
Member

Choose a reason for hiding this comment

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

I'm confused. I'm literally quoting release-tasks.md in https://github.com/kubernetes-sigs/cluster-api/pull/9119/files#r1284500772 :)

Copy link
Member

Choose a reason for hiding this comment

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

We just don't literally call out the individual tables I think. Otherwise it's covered

Copy link
Member

Choose a reason for hiding this comment

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

@sbueringer I see now. in release-tasks.md looks like we are mentioning it twice: https://github.com/kubernetes-sigs/cluster-api/blob/main/docs/release/release-tasks.md#update-supported-versions and in https://github.com/kubernetes-sigs/cluster-api/blob/main/docs/release/release-tasks.md#repeatedly-cut-a-release number 6 in the list. I wonder if we need it in both places, since we are referring (in Prior art) to update same files in both cases

Copy link
Member

@sbueringer sbueringer Aug 7, 2023

Choose a reason for hiding this comment

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

The idea was:

  • At the beginning of a new cycle:
    • Add the new version that we are now developing to versions.md
  • After we cut the minor release:
    • Set the EOL date for the version that is now EOL in contributing.md
    • Add the minor release we just created to the same table in contributing.md

Not entirely sure but I think we don't mention it twice, the PRs just have similar names. And in one case we had some cleanup additionally to do in versions.md for some reason (I think because the other task wasn't done as documented before)

Copy link
Contributor Author

Choose a reason for hiding this comment

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

done

docs/book/src/reference/versions.md Outdated Show resolved Hide resolved
@furkatgofurov7
Copy link
Member

/cc @killianmuldoon @sbueringer

@furkatgofurov7
Copy link
Member

/cc @chrischdi

CONTRIBUTING.md Outdated Show resolved Hide resolved
@k8s-ci-robot k8s-ci-robot added size/M Denotes a PR that changes 30-99 lines, ignoring generated files. and removed size/L Denotes a PR that changes 100-499 lines, ignoring generated files. labels Aug 7, 2023
CONTRIBUTING.md Outdated
@@ -174,7 +175,7 @@ Cluster API maintains the most recent release/releases for all supported API and

(*) Previous support policy applies, older minor releases were immediately unsupported when a new major/minor release was available

- Exceptions can be filed with maintainers and taken into consideration on a case-by-case basis.
- Exceptions can be filed with maintainers and taken into consideration on a case-by-case basis.giu
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
- Exceptions can be filed with maintainers and taken into consideration on a case-by-case basis.giu
- Exceptions can be filed with maintainers and taken into consideration on a case-by-case basis.

Copy link
Member

Choose a reason for hiding this comment

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

@g-gaston still open :)

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Apologies Stefan, I committed your suggestion from the UI, I'm not sure how this got lost.
Fixed

Copy link
Member

Choose a reason for hiding this comment

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

No problem

@nawazkh
Copy link
Member

nawazkh commented Aug 9, 2023

Looks good to me, but leaving lgtm for the folks you are waiting to hear back from. Thank you for putting this together @g-gaston !

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.

/lgtm

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

LGTM label has been added.

Git tree hash: 10e3643db4feda26adccf059e32df9e7c823aca6

@k8s-ci-robot k8s-ci-robot removed the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Aug 9, 2023
@k8s-ci-robot k8s-ci-robot added needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. size/XXL Denotes a PR that changes 1000+ lines, ignoring generated files. and removed size/M Denotes a PR that changes 30-99 lines, ignoring generated files. labels Aug 9, 2023
@k8s-ci-robot k8s-ci-robot added size/M Denotes a PR that changes 30-99 lines, ignoring generated files. and removed needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. size/XXL Denotes a PR that changes 1000+ lines, ignoring generated files. labels Aug 9, 2023
@k8s-ci-robot
Copy link
Contributor

@g-gaston: 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
pull-cluster-api-e2e-informing-main f67181c link false /test pull-cluster-api-e2e-informing-main
pull-cluster-api-test-main f67181c link true /test pull-cluster-api-test-main
pull-cluster-api-e2e-main f67181c link true /test pull-cluster-api-e2e-main

Full PR test history. Your PR dashboard. Please help us cut down on flakes by linking to an open issue when you hit one in your PR.

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/test-infra repository. I understand the commands that are listed here.

@g-gaston
Copy link
Contributor Author

g-gaston commented Aug 9, 2023

/retest-required

@sbueringer
Copy link
Member

Last nit: #9119 (comment)

Tables are looking good now

@sbueringer
Copy link
Member

Thank you!!

/lgtm
/approve

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

LGTM label has been added.

Git tree hash: e779d542b25a870a567ab25989a6e30dcd9c51ef

@k8s-ci-robot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: sbueringer

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 Aug 9, 2023
@k8s-ci-robot k8s-ci-robot merged commit d7229e5 into kubernetes-sigs:main Aug 9, 2023
11 checks passed
@k8s-ci-robot k8s-ci-robot added this to the v1.6 milestone Aug 9, 2023
@furkatgofurov7 furkatgofurov7 mentioned this pull request Aug 18, 2023
29 tasks
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. area/documentation Issues or PRs related to documentation 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/M Denotes a PR that changes 30-99 lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants