-
Notifications
You must be signed in to change notification settings - Fork 2.9k
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
chore(docs): refresh compatibility matrix to include versions 1.29 and 1.30 #1354
base: master
Are you sure you want to change the base?
Conversation
|
Welcome @joselitofilho! |
Hi @joselitofilho. Thanks for your PR. I'm waiting for a kubernetes member to verify that this patch is reasonable to test. If it is, they should reply with Once the patch is verified, the new status will be reflected by the I understand the commands that are listed here. 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. |
[APPROVALNOTIFIER] This PR is NOT APPROVED This pull-request has been approved by: joselitofilho The full list of commands accepted by this bot can be found here.
Needs approval from an approver in each of these files:
Approvers can indicate their approval by writing |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
/ok-to-test
@tao12345666333, The failure isn't related to this change. What should we do? |
/retest |
…d 1.30 Bring the compatibility matrix up-to-date to include version 1.29 and 1.30 of Kubernetes
/retest |
@joselitofilho: The following test failed, say
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-sigs/prow repository. I understand the commands that are listed here. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Review for PR: Refresh Compatibility Matrix (chore: docs)
Title: Refresh Compatibility Matrix to Include Versions 1.29 and 1.30
1. Correctness of Documentation Update:
- Matrix Update: The primary change is the addition of two new versions of Kubernetes (
1.29
,1.30
). The compatibility matrix has been updated in a consistent manner:- Each row in the table correctly adds the new version tags.
- Proper usage of symbols:
✓
: Indicates full compatibility.+
/-
: Denotes partial feature compatibility or deprecated/removed features.
- The PR does not introduce unnecessary complexity into the documentation and only updates the compatibility matrix.
Suggestion: Ensure that the new tags and versions have undergone sufficient testing to verify that the indicated compatibility is accurate. This is a documentation change, but correctness is still crucial to avoid misleading users.
2. Commit Message Clarity:
- The title and commit message are clear, specifying that this is a documentation refresh to update the compatibility matrix to include versions
1.29
and1.30
.
Suggestion: Add a note in the commit body that outlines how these versions have been tested and confirmed compatible.
3. Formatting and Consistency:
- The table is well-formatted and follows the existing structure used for previous versions of Kubernetes (1.23–1.28).
- The key symbols (
✓
,+-
, etc.) are consistently used throughout the document, maintaining a standardized approach to representing compatibility.
Suggestion: None. The formatting looks clean and follows the established convention.
4. some considerations:
- The key explaining the symbols (✓, +-, etc.) is well-placed at the bottom of the table and is consistent with previous entries.
- The description under the "Compatibility: client-go <-> Kubernetes clusters" section is clear and informs users about backwards compatibility and supported versions.
Suggestion: Since Kubernetes frequently changes APIs, consider adding a section on "Known Issues" that lists any deprecated APIs or major incompatibilities introduced in the 1.29 and 1.30 updates, if applicable.
Additional Documentation Suggestions:
-
Go Version and Dependency Notes:
- This section provides instructions on how to fetch the client-go library with specific versions of Go (1.16 and above). The instructions are clear and help developers easily install the correct version of the library.
Improvement: Include a short note about how developers can confirm their Kubernetes cluster version, as this is a critical piece of information for selecting the correct client-go version.
-
Semantic Versioning Clarification:
- The documentation does a good job of explaining the relationship between Kubernetes tags (e.g.,
kubernetes-1.29.0
andv0.29.0
) and the corresponding client-go versions.
Improvement: Add an explicit link to the semantic versioning guidelines for users unfamiliar with it.
- The documentation does a good job of explaining the relationship between Kubernetes tags (e.g.,
@joselitofilho Sorry for the long delay, I have opened a PR to fix the prow job kubernetes/test-infra#33571 After it has been merged, we can re-run this test |
Bring the compatibility matrix up-to-date to include version 1.29 and 1.30 of Kubernetes.
Fixes #1353