Deprecate v1 projects #1137

hypnoglow · 2019-10-28T19:58:03Z

This PR deprecates v1 projects. Fixes #1136

k8s-ci-robot · 2019-10-28T19:58:11Z

Welcome @hypnoglow!

It looks like this is your first PR to kubernetes-sigs/kubebuilder 🎉. 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-sigs/kubebuilder 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 · 2019-10-28T19:58:11Z

Hi @hypnoglow. Thanks for your PR.

I'm waiting for a kubernetes-sigs 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.

hypnoglow · 2019-10-28T19:59:08Z

cmd/main.go

@@ -188,3 +191,20 @@ func getProjectVersion() (bool, string) {
 	}
 	return true, projectInfo.Version
 }
+
+func printV1DeprecationWarning() {
+	fmt.Printf(`=============== DEPRECATION WARNING ===============


If this looks too aggressive, let me know how to rephrase/reformat it.

We can try making it more concise. How about:

warning: [deprecation] v1 projects are deprecated and will not be supported beyond Feb 1, 2020. Refer to https://book.kubebuilder.io/migration/guide.html for more details.

Thanks for the suggestion! Done

hypnoglow · 2019-10-28T20:00:31Z

cmd/main.go

+
+func printV1DeprecationWarning() {
+	fmt.Printf(`=============== DEPRECATION WARNING ===============
+v1 projects are deprecated. The support for v1 projects will be dropped at 1 February 2020. 


I dropped an approximate date, please correct me if it is wrong.

What about a broad date such as "first 2020 quarter"? @droot

Giving a specific date makes the message more clear and that's the intent behind this.

droot

Thanks for working on this. A few minor suggestions.

droot · 2019-10-30T17:04:44Z

cmd/main.go

@@ -188,3 +191,20 @@ func getProjectVersion() (bool, string) {
 	}
 	return true, projectInfo.Version
 }
+
+func printV1DeprecationWarning() {
+	fmt.Printf(`=============== DEPRECATION WARNING ===============


We can try making it more concise. How about:

warning: [deprecation] v1 projects are deprecated and will not be supported beyond Feb 1, 2020. Refer to https://book.kubebuilder.io/migration/guide.html for more details.

droot · 2019-10-30T17:05:44Z

cmd/main.go

+
+func printV1DeprecationWarning() {
+	fmt.Printf(`=============== DEPRECATION WARNING ===============
+v1 projects are deprecated. The support for v1 projects will be dropped at 1 February 2020. 


Giving a specific date makes the message more clear and that's the intent behind this.

droot · 2019-10-30T17:14:53Z

cmd/main.go

@@ -112,7 +113,9 @@ func main() {
 	)

 	foundProject, version := getProjectVersion()
-	if foundProject && version == "1" {
+	if foundProject && version == project.Version1 {


Cobra command library does provide mechanism to mark commands as deprecated but I think the implemented approach will work better for our case.

droot · 2019-10-30T21:29:25Z

/ok-to-test

camilamacedo86 · 2019-11-04T23:42:21Z

cmd/main.go

@@ -188,3 +191,7 @@ func getProjectVersion() (bool, string) {
 	}
 	return true, projectInfo.Version
 }
+
+func printV1DeprecationWarning() {
+	fmt.Printf("warning: [deprecation] v1 projects are deprecated and will not be supported beyond Feb 1, 2020. Refer to https://book.kubebuilder.io/migration/guide.html for more details.\n")


WDYT about:

Suggested change

fmt.Printf("warning: [deprecation] v1 projects are deprecated and will not be supported beyond Feb 1, 2020. Refer to https://book.kubebuilder.io/migration/guide.html for more details.\n")

fmt.Printf("warning: [deprecation] v1 projects are deprecated and will not be supported beyond Feb 1, 2020. See the https://book.kubebuilder.io/migration/guide.html for know how to migrate the project to from v1 to v2.\n")

@camilamacedo86 Is the "See ... for know how to ..." correct English? Sorry for this question, I'm not a native speaker, thus I never heard this idiom :)

@camilamacedo86 ping, I would be thankful if you clarify this moment for me.

... for know how to ... and project to from are definetely typos. I would go for ... Refer to https://.. for instructions on how to migrate to v2.\n. Saying from v1 doesn't give that much info as you already said that v1 is the one being deprecated.

Just my 2 cents.

@Adirio agreed, thanks for help.

I was not clear in my suggestion. Sorry. It is updated bellow.

camilamacedo86

Besides the nit . It shows /lgtm for me.

Adirio · 2019-11-05T20:17:04Z

cmd/main.go

@@ -112,7 +113,9 @@ func main() {
 	)

 	foundProject, version := getProjectVersion()
-	if foundProject && version == "1" {
+	if foundProject && version == project.Version1 {


Why do you suggest to do this change from another PR (#1143) into this?

Hi @Adirio,

Because this PR is doing/replacing if foundProject && version == "1" { for if foundProject && version == project.Version1 {.

So, as part of its review, I am suggesting if foundProject && version == "1" { for if hasProjectFile && projectVersion == project.Version1 { instead of.

I agree that @camilamacedo86 suggested naming is more suitable. But I also agree that we can lay it on #1143, as the narrow scope of my change was only to replace the string "1" with the constant project.Version1, and not to change other things.

If you still think we should introduce this change here, let me know.

@hypnoglow The change she is suggesting is not just a more suitable name, it has to do with the package with the same alias (version). The context is missing as this is a change I suggested in #1143 and she suggested a name change. Suggesting to change this here makes no sense as this PR is about a completely different topic.

It is not a big deal so I am OK with.

camilamacedo86 · 2019-11-07T00:30:17Z

/assign @camilamacedo86

camilamacedo86 · 2019-11-07T01:00:38Z

cmd/main.go

@@ -188,3 +191,7 @@ func getProjectVersion() (bool, string) {
 	}
 	return true, projectInfo.Version
 }
+
+func printV1DeprecationWarning() {
+	fmt.Printf("warning: [deprecation] v1 projects are deprecated and will not be supported beyond Feb 1, 2020. Refer to https://book.kubebuilder.io/migration/guide.html for instructions on how to migrate to v2.\n")


My suggestion is to keep the text more friendly as it is done in its docs + few nits.

// add const on top const ( NoticeColor = "\033[1;36m%s\033[0m" )

Suggested change

fmt.Printf("warning: [deprecation] v1 projects are deprecated and will not be supported beyond Feb 1, 2020. Refer to https://book.kubebuilder.io/migration/guide.html for instructions on how to migrate to v2.\n")

fmt.Printf(NoticeColor,"[Deprecation Notice] : v1 projects are deprecated and will not be supported beyond Feb 1, 2020.\n See how to upgrade your project to v2: https://book.kubebuilder.io/migration/guide.html\n")

Following its result.

camilamacedo86

I tested it working locally. It is working for the init command and others as requested in the issue. 🥇 Well done. Just apply the suggested nit and I think it will be ok to be merged.

camilamacedo86

/lgtm /approved 🥇 for me.
@droot @mengqiy wdyt? Let's merge this one

camilamacedo86 · 2019-11-08T16:36:00Z

/assign @diroot

k8s-ci-robot · 2019-11-08T16:36:02Z

@camilamacedo86: GitHub didn't allow me to assign the following users: diroot.

Note that only kubernetes-sigs members, repo collaborators and people who have commented on this issue/PR can be assigned. Additionally, issues/PRs can only have 10 assignees at the same time.
For more information please see the contributor guide

In response to this:

/assign @diroot

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.

mengqiy

/lgtm
/approve

Thanks for working on this.
Let's get this in!

k8s-ci-robot · 2019-11-08T17:43:57Z

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: hypnoglow, mengqiy

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:

~~OWNERS~~ [mengqiy]

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 added the cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. label Oct 28, 2019

k8s-ci-robot added needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. size/S Denotes a PR that changes 10-29 lines, ignoring generated files. labels Oct 28, 2019

k8s-ci-robot requested review from droot and Liujingfang1 October 28, 2019 19:58

hypnoglow commented Oct 28, 2019

View reviewed changes

droot reviewed Oct 30, 2019

View reviewed changes

hypnoglow force-pushed the deprecate-v1 branch from a7d108c to 1cf7b16 Compare October 30, 2019 20:16

hypnoglow requested a review from droot October 30, 2019 20:17

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 Oct 30, 2019

Adirio mentioned this pull request Oct 31, 2019

Extract Resource from the v1 Scaffolding package #1144

Closed

camilamacedo86 reviewed Nov 4, 2019

View reviewed changes

camilamacedo86 approved these changes Nov 4, 2019

View reviewed changes

camilamacedo86 reviewed Nov 5, 2019

View reviewed changes

hypnoglow force-pushed the deprecate-v1 branch from 1cf7b16 to fd98bde Compare November 6, 2019 20:59

hypnoglow requested a review from camilamacedo86 November 6, 2019 21:01

k8s-ci-robot assigned camilamacedo86 Nov 7, 2019

camilamacedo86 reviewed Nov 7, 2019

View reviewed changes

camilamacedo86 requested changes Nov 7, 2019

View reviewed changes

Adirio approved these changes Nov 7, 2019

View reviewed changes

hypnoglow force-pushed the deprecate-v1 branch from fd98bde to 9ceebf0 Compare November 7, 2019 20:05

hypnoglow requested a review from camilamacedo86 November 7, 2019 20:05

Deprecate v1 projects

9ceebf0

camilamacedo86 approved these changes Nov 7, 2019

View reviewed changes

mengqiy approved these changes Nov 8, 2019

View reviewed changes

k8s-ci-robot assigned mengqiy Nov 8, 2019

k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Nov 8, 2019

k8s-ci-robot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Nov 8, 2019

k8s-ci-robot merged commit 1e27332 into kubernetes-sigs:master Nov 8, 2019

camilamacedo86 mentioned this pull request Dec 5, 2019

Deprecate 'generate openapi', add 'generate crds' operator-framework/operator-sdk#2276

Merged

	fmt.Printf("warning: [deprecation] v1 projects are deprecated and will not be supported beyond Feb 1, 2020. Refer to https://book.kubebuilder.io/migration/guide.html for more details.\n")
	fmt.Printf("warning: [deprecation] v1 projects are deprecated and will not be supported beyond Feb 1, 2020. See the https://book.kubebuilder.io/migration/guide.html for know how to migrate the project to from v1 to v2.\n")

	fmt.Printf("warning: [deprecation] v1 projects are deprecated and will not be supported beyond Feb 1, 2020. Refer to https://book.kubebuilder.io/migration/guide.html for instructions on how to migrate to v2.\n")
	fmt.Printf(NoticeColor,"[Deprecation Notice] : v1 projects are deprecated and will not be supported beyond Feb 1, 2020.\n See how to upgrade your project to v2: https://book.kubebuilder.io/migration/guide.html\n")

Deprecate v1 projects #1137

Deprecate v1 projects #1137

Conversation

hypnoglow commented Oct 28, 2019

k8s-ci-robot commented Oct 28, 2019

k8s-ci-robot commented Oct 28, 2019

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

droot left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

droot commented Oct 30, 2019

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

camilamacedo86 Nov 7, 2019 • edited Loading

Choose a reason for hiding this comment

camilamacedo86 left a comment

Choose a reason for hiding this comment

This comment was marked as resolved.

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

camilamacedo86 commented Nov 7, 2019

camilamacedo86 Nov 7, 2019 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

camilamacedo86 left a comment • edited Loading

Choose a reason for hiding this comment

camilamacedo86 left a comment

Choose a reason for hiding this comment

camilamacedo86 commented Nov 8, 2019

k8s-ci-robot commented Nov 8, 2019

mengqiy left a comment

Choose a reason for hiding this comment

k8s-ci-robot commented Nov 8, 2019

camilamacedo86 Nov 7, 2019 •

edited

Loading

camilamacedo86 Nov 7, 2019 •

edited

Loading

camilamacedo86 left a comment •

edited

Loading