-
Notifications
You must be signed in to change notification settings - Fork 1.7k
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
Migration subcommand deprecation message added #3319
Migration subcommand deprecation message added #3319
Conversation
9d64524
to
baeeeb6
Compare
migration: | ||
header: The migrate subcommand has been deprecated | ||
body: > | ||
```operator-sdk migrate``` has been deprecated |
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.
Please add a new line here. Also, you would have to run make generate
and commit the changes, it would update the cli-docs for this command.
- description: > | ||
The migrate sub-command is deprecated | ||
kind: deprecation | ||
breaking: true |
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.
Not sure if deprecation can be a breaking change. I think this should be false
.
migration: | ||
header: The migrate subcommand has been deprecated | ||
body: > | ||
```operator-sdk migrate``` has been deprecated |
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.
migration: | |
header: The migrate subcommand has been deprecated | |
body: > | |
```operator-sdk migrate``` has been deprecated |
cmd/operator-sdk/migrate/cmd.go
Outdated
@@ -41,7 +41,8 @@ func NewCmd() *cobra.Command { | |||
Short: "Adds source code to an operator", | |||
Long: `operator-sdk migrate adds a main.go source file and any associated source files` + | |||
`for an operator that is not of the "go" type.`, | |||
RunE: migrateRun, | |||
RunE: migrateRun, | |||
Deprecated: "The migrate sub-command is deprecated", |
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.
Deprecated: "The migrate sub-command is deprecated", | |
Deprecated: "and will be removed by the operator-sdk v1.0.0 release", |
4391603
to
9ea94b0
Compare
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.
/lgtm pending Eric/Varsha's approval
cmd/operator-sdk/migrate/cmd.go
Outdated
@@ -41,7 +41,8 @@ func NewCmd() *cobra.Command { | |||
Short: "Adds source code to an operator", | |||
Long: `operator-sdk migrate adds a main.go source file and any associated source files` + | |||
`for an operator that is not of the "go" type.`, | |||
RunE: migrateRun, | |||
RunE: migrateRun, | |||
Deprecated: "and will be removed soon", |
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.
Deprecated: "and will be removed soon", | |
Deprecated: "and will be removed prior to operator-sdk v1.0.0", |
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.
LGTM
9ea94b0
to
57f89e8
Compare
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.
/lgtm
* Migration subcommand deprecation message added * Generated the docs and modified changelog
Description of the change:
OSDK-1312
Notifies the user about the deprecation of the migration sub-command
Checklist
If the pull request includes user-facing changes, extra documentation is required:
changelog/fragments
(seechangelog/fragments/00-template.yaml
)website/content/en/docs