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

chore(docs): refresh compatibility matrix to include versions 1.29 and 1.30 #1354

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

joselitofilho
Copy link

Bring the compatibility matrix up-to-date to include version 1.29 and 1.30 of Kubernetes.

Fixes #1353

Copy link

linux-foundation-easycla bot commented Apr 24, 2024

CLA Signed

The committers listed above are authorized under a signed CLA.

  • ✅ login: joselitofilho / name: Joselito Viveiros Nogueira Filho (27b4392)

@k8s-ci-robot k8s-ci-robot added the cncf-cla: no Indicates the PR's author has not signed the CNCF CLA. label Apr 24, 2024
@k8s-ci-robot
Copy link
Contributor

Welcome @joselitofilho!

It looks like this is your first PR to kubernetes/client-go 🎉. Please refer to our pull request process documentation to help your PR have a smooth ride to approval.

You will be prompted by a bot to use commands during the review process. Do not be afraid to follow the prompts! It is okay to experiment. Here is the bot commands documentation.

You can also check if kubernetes/client-go has its own contribution guidelines.

You may want to refer to our testing guide if you run into trouble with your tests not passing.

If you are having difficulty getting your pull request seen, please follow the recommended escalation practices. Also, for tips and tricks in the contribution process you may want to read the Kubernetes contributor cheat sheet. We want to make sure your contribution gets all the attention it needs!

Thank you, and welcome to Kubernetes. 😃

@k8s-ci-robot k8s-ci-robot added the needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. label Apr 24, 2024
@k8s-ci-robot
Copy link
Contributor

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 /ok-to-test on its own line. Until that is done, I will not automatically test new commits in this PR, but the usual testing commands by org members will still work. Regular contributors should join the org to skip this step.

Once the patch is verified, the new status will be reflected by the ok-to-test label.

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.

@k8s-ci-robot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by: joselitofilho
Once this PR has been reviewed and has the lgtm label, please assign deads2k for approval. For more information see the Kubernetes Code Review Process.

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 /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@k8s-ci-robot k8s-ci-robot added sig/api-machinery Categorizes an issue or PR as relevant to SIG API Machinery. size/S Denotes a PR that changes 10-29 lines, ignoring generated files. cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. and removed cncf-cla: no Indicates the PR's author has not signed the CNCF CLA. labels Apr 24, 2024
Copy link
Member

@tao12345666333 tao12345666333 left a comment

Choose a reason for hiding this comment

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

/ok-to-test

@k8s-ci-robot k8s-ci-robot added ok-to-test Indicates a non-member PR verified by an org member that is safe to test. and removed needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. labels May 26, 2024
@joselitofilho
Copy link
Author

@tao12345666333, The failure isn't related to this change. What should we do?

@joselitofilho
Copy link
Author

/retest

…d 1.30

Bring the compatibility matrix up-to-date to include version 1.29 and 1.30 of Kubernetes
@joselitofilho
Copy link
Author

/retest

@k8s-ci-robot
Copy link
Contributor

@joselitofilho: The following test 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-client-go-build 27b4392 link true /test pull-client-go-build

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.

Copy link

@sundaram2021 sundaram2021 left a 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 and 1.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:

  1. 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.

  2. Semantic Versioning Clarification:

    • The documentation does a good job of explaining the relationship between Kubernetes tags (e.g., kubernetes-1.29.0 and v0.29.0) and the corresponding client-go versions.

    Improvement: Add an explicit link to the semantic versioning guidelines for users unfamiliar with it.

@tao12345666333
Copy link
Member

tao12345666333 commented Oct 2, 2024

@tao12345666333, The failure isn't related to this change. What should we do?

@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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. ok-to-test Indicates a non-member PR verified by an org member that is safe to test. sig/api-machinery Categorizes an issue or PR as relevant to SIG API Machinery. size/S Denotes a PR that changes 10-29 lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

The compatibility-matrix needs to be updated to include versions 1.29 and 1.30 in README.md
4 participants