From 4ce039eb0c7daf39458df50cdd305aaa2c149ce4 Mon Sep 17 00:00:00 2001 From: Haseeb Tariq Date: Wed, 17 Jun 2020 15:43:24 -0700 Subject: [PATCH 1/2] Add CHANGELOG fragments for new CLI --- .../3190-add-new-cli-for-go-operators.yaml | 13 +++++++++++++ ...190-deprecate-old-cli-for-go-operators.yaml | 18 ++++++++++++++++++ .../3190-remove-new-cmd-for-go-operators.yaml | 11 +++++++++++ 3 files changed, 42 insertions(+) create mode 100644 changelog/fragments/3190-add-new-cli-for-go-operators.yaml create mode 100644 changelog/fragments/3190-deprecate-old-cli-for-go-operators.yaml create mode 100644 changelog/fragments/3190-remove-new-cmd-for-go-operators.yaml diff --git a/changelog/fragments/3190-add-new-cli-for-go-operators.yaml b/changelog/fragments/3190-add-new-cli-for-go-operators.yaml new file mode 100644 index 0000000000..8818889522 --- /dev/null +++ b/changelog/fragments/3190-add-new-cli-for-go-operators.yaml @@ -0,0 +1,13 @@ +entries: + - description: > + The `operator-sdk` binary has a new CLI workflow and project layout + for scaffolding Go operators that is aligned with Kubebuilder's CLI + and project layout. + See the new [Quickstart Guide](https://sdk.operatorframework.io/docs/golang/quickstart) + and the new [CLI reference](https://sdk.operatorframework.io/docs/new-cli) for more details. + + kind: "addition" + + breaking: false + + pull_request_override: 3190 diff --git a/changelog/fragments/3190-deprecate-old-cli-for-go-operators.yaml b/changelog/fragments/3190-deprecate-old-cli-for-go-operators.yaml new file mode 100644 index 0000000000..809c931c62 --- /dev/null +++ b/changelog/fragments/3190-deprecate-old-cli-for-go-operators.yaml @@ -0,0 +1,18 @@ +entries: + - description: > + With the introduction of the new [Kubebuilder aligned CLI](https://sdk.operatorframework.io/docs/new-cli) + and project layout for Go operators, the [old CLI](https://sdk.operatorframework.io/docs/cli) + will stil continue to work for Go projects scaffolded in the old layout with `operator-sdk new`. + However the old CLI is now deprecated and will be removed in a future release. + + kind: "deprecation" + + breaking: false + + pull_request_override: 3190 + + migration: + header: Migrating Go projects to the new Kubebuilder aligned project layout + body: > + See the [migration guide](https://sdk.operatorframework.io/docs/golang/project_migration_guide/) + that walks through an example how to migrate a Go based operator project from the old layout to the new layout. diff --git a/changelog/fragments/3190-remove-new-cmd-for-go-operators.yaml b/changelog/fragments/3190-remove-new-cmd-for-go-operators.yaml new file mode 100644 index 0000000000..d8e18f6a8e --- /dev/null +++ b/changelog/fragments/3190-remove-new-cmd-for-go-operators.yaml @@ -0,0 +1,11 @@ +entries: + - description: > + The `operator-sdk new` command no longer supports scaffolding new Go projects with the `--type=Go` flag. + To scaffold new projects, users are expected to use `operator-sdk init` as part of the + [new CLI]((https://sdk.operatorframework.io/docs/new-cli)) for Go operators. + + kind: "removal" + + breaking: false + + pull_request_override: 3190 From 5edca27526a8cb017a58819dd4a6e1832125e18d Mon Sep 17 00:00:00 2001 From: Haseeb Tariq Date: Thu, 18 Jun 2020 16:01:43 -0700 Subject: [PATCH 2/2] fix typos --- .../fragments/3190-deprecate-old-cli-for-go-operators.yaml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/changelog/fragments/3190-deprecate-old-cli-for-go-operators.yaml b/changelog/fragments/3190-deprecate-old-cli-for-go-operators.yaml index 809c931c62..269e63e2c3 100644 --- a/changelog/fragments/3190-deprecate-old-cli-for-go-operators.yaml +++ b/changelog/fragments/3190-deprecate-old-cli-for-go-operators.yaml @@ -2,7 +2,7 @@ entries: - description: > With the introduction of the new [Kubebuilder aligned CLI](https://sdk.operatorframework.io/docs/new-cli) and project layout for Go operators, the [old CLI](https://sdk.operatorframework.io/docs/cli) - will stil continue to work for Go projects scaffolded in the old layout with `operator-sdk new`. + will still continue to work for Go projects scaffolded in the old layout with `operator-sdk new`. However the old CLI is now deprecated and will be removed in a future release. kind: "deprecation" @@ -15,4 +15,4 @@ entries: header: Migrating Go projects to the new Kubebuilder aligned project layout body: > See the [migration guide](https://sdk.operatorframework.io/docs/golang/project_migration_guide/) - that walks through an example how to migrate a Go based operator project from the old layout to the new layout. + that walks through an example of how to migrate a Go based operator project from the old layout to the new layout.