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.

Sign up for GitHub

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

Jump to bottom

⚠️ officially deprecate go/v2 plugin (legacy layout Kubebuilder 2.x) #2734

Merged
merged 2 commits into from
Jun 21, 2022
Merged

⚠️ officially deprecate go/v2 plugin (legacy layout Kubebuilder 2.x) #2734

merged 2 commits into from
Jun 21, 2022

Conversation

camilamacedo86
Copy link
Member

@camilamacedo86 camilamacedo86 commented Jun 16, 2022 •
edited
Loading

Description
officially deprecate go/v2 plugin

Motivation

  • It uses the Project schema v2 which does not allow us to properly work with the plugins ecosystem
  • We are unable to update this plugin and the projects scaffold cannot work with Kubebernetes versions >= 1.22
  • It was built only to ensure backwards compatibility with the Kubebuilder 2.x layout

Closes: #2705

@k8s-ci-robot
Copy link
Contributor

Skipping CI for Draft Pull Request.
If you want CI signal for your change, please convert it to an actual PR.
You can still manually trigger a test run with /test all

@k8s-ci-robot k8s-ci-robot added do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. 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 Jun 16, 2022
@k8s-ci-robot k8s-ci-robot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Jun 16, 2022
@camilamacedo86 camilamacedo86 marked this pull request as ready for review June 16, 2022 06:53
@k8s-ci-robot k8s-ci-robot removed the do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. label Jun 16, 2022
@camilamacedo86
Copy link
Member Author

/hold

To get the reviews only

@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 Jun 16, 2022
@camilamacedo86 camilamacedo86 added this to the 3.5.0 milestone Jun 16, 2022
everettraven
everettraven suggested changes Jun 16, 2022
View reviewed changes
Copy link
Contributor

@everettraven everettraven left a comment

Choose a reason for hiding this comment

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

Just some minor wording changes

pkg/plugins/golang/v2/plugin.go Outdated Show resolved Hide resolved
pkg/plugins/golang/v2/plugin.go Outdated Show resolved Hide resolved
pkg/plugins/golang/v2/plugin.go Outdated Show resolved Hide resolved
pkg/plugins/golang/v2/plugin.go Outdated Show resolved Hide resolved
docs/book/src/plugins/go-v2-plugin.md Outdated Show resolved Hide resolved
@camilamacedo86
Copy link
Member Author

camilamacedo86 commented Jun 16, 2022 •
edited
Loading

/tide merge-method-squash

@camilamacedo86
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 Jun 17, 2022
rashmigottipati
rashmigottipati reviewed Jun 17, 2022
View reviewed changes
Copy link
Contributor

@rashmigottipati rashmigottipati left a comment

Choose a reason for hiding this comment

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

Should we add deprecation warning in documentation as well?

Here are the links:

@camilamacedo86
Copy link
Member Author

camilamacedo86 commented Jun 17, 2022 •
edited
Loading

HI @rashmigottipati,

Should we add deprecation warning in documentation as well?

Here are the links:

available-plugins.md
SUMMARY.md

The info is in the doc where the other plugins are doc already so I do not think that is required here.
When we do the release we might want to supplement with it as well. WDYT?

OR

Is it about the warning when users run the commands and are using the old legacy plugin?
About this one, I do think that is a good idea to add the links because the msg will appear when people are using it via nay project that consumes KB as a lib. (for i.e. SDK).

@camilamacedo86 camilamacedo86 changed the title ⚠️ officially deprecate go/v2 plugin ⚠️ officially deprecate go/v2 plugin (legacy layout Kubebuilder 2.x) Jun 19, 2022
@everettraven
Copy link
Contributor

Should we add deprecation warning in documentation as well?
Here are the links:
available-plugins.md
SUMMARY.md

The info is in the doc where the other plugins are doc already so I do not think that is required here. When we do the release we might want to supplement with it as well. WDYT?

OR

Is it about the warning when users run the commands and are using the old legacy plugin? About this one, I do think that is a good idea to add the links because the msg will appear when people are using it via nay project that consumes KB as a lib. (for i.e. SDK).

I agree here with @rashmigottipati that it would be a good idea to update all the documentation that mentions the go/v2 plugin to have some text next to it that says that it is deprecated. This way if someone is looking at the documentation prior to actually using the Kubebuilder tool, they will know the go/v2 plugin is deprecated without having to read further in the docs.

I do see that in the documentation it already recommends not using it unless you need the legacy layout, but I think adding a deprecated marking would still be good since it gives warning in the documentation the the go/v2 plugin will be getting removed sometime in the future.

I think just simply adding something like [Deprecated] next to all references would work well.

rashmigottipati
rashmigottipati reviewed Jun 21, 2022
View reviewed changes
Copy link
Contributor

@rashmigottipati rashmigottipati left a comment

Choose a reason for hiding this comment

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

I'm good with adding [Deprecated] next to all references in the docs based on @everettraven's suggestion.

It will be nice to add this warning before completely removing support for the go/v2 plugin.

rashmigottipati
rashmigottipati approved these changes Jun 21, 2022
View reviewed changes
Copy link
Contributor

@rashmigottipati rashmigottipati left a comment

Choose a reason for hiding this comment

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

/lgtm

everettraven
everettraven reviewed Jun 21, 2022
View reviewed changes
Copy link
Contributor

@everettraven everettraven left a comment

Choose a reason for hiding this comment

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

Some minor wording nits

docs/book/src/plugins/available-plugins.md Outdated Show resolved Hide resolved
docs/book/src/plugins/available-plugins.md Outdated Show resolved Hide resolved
docs/book/src/plugins/available-plugins.md Outdated Show resolved Hide resolved
@k8s-ci-robot k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Jun 21, 2022
@rashmigottipati
Copy link
Contributor

/hold
to address @everettraven review

@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 Jun 21, 2022
@camilamacedo86 camilamacedo86 mentioned this pull request Jun 21, 2022
Closed
@k8s-ci-robot k8s-ci-robot removed the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Jun 21, 2022
@everettraven
⚠️ officially deprecate go/v2 plugin
e83c9d7 
Co-authored-by: Bryce Palmer <everettraven@gmail.com>
@camilamacedo86 @everettraven
Update docs/book/src/plugins/available-plugins.md
6765fcf 
Co-authored-by: Bryce Palmer <everettraven@gmail.com>
@camilamacedo86
Copy link
Member Author

/label tide/merge-method-squash

@k8s-ci-robot k8s-ci-robot added the tide/merge-method-squash Denotes a PR that should be squashed by tide when it merges. label Jun 21, 2022
everettraven
everettraven approved these changes Jun 21, 2022
View reviewed changes
Copy link
Contributor

@everettraven everettraven 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
Copy link
Contributor

@everettraven: changing LGTM is restricted to collaborators

In response to this:

/lgtm

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.

rashmigottipati
rashmigottipati approved these changes Jun 21, 2022
View reviewed changes
Copy link
Contributor

@rashmigottipati rashmigottipati left a comment

Choose a reason for hiding this comment

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

/hold cancel
/lgtm

@k8s-ci-robot k8s-ci-robot added lgtm "Looks good to me", indicates that a PR is ready to be merged. and removed do-not-merge/hold Indicates that a PR should not merge because someone has issued a /hold command. labels Jun 21, 2022
@k8s-ci-robot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: camilamacedo86, everettraven, rashmigottipati

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 merged commit e67c488 into kubernetes-sigs:master Jun 21, 2022
@camilamacedo86 camilamacedo86 deleted the deprecated-go-v2 branch June 21, 2022 18:03
@everettraven everettraven mentioned this pull request Jun 24, 2022
Closed
9 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@rashmigottipati rashmigottipati rashmigottipati approved these changes

@everettraven everettraven everettraven approved these changes

@joelanford joelanford Awaiting requested review from joelanford

@pwittrock pwittrock Awaiting requested review from pwittrock

Assignees

@rashmigottipati rashmigottipati

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/M Denotes a PR that changes 30-99 lines, ignoring generated files. tide/merge-method-squash Denotes a PR that should be squashed by tide when it merges.
Projects
None yet
Milestone
3.5.0
4 participants
@camilamacedo86 @k8s-ci-robot @everettraven @rashmigottipati