From 3a7cbc6635cf9f70b09f5f0a1592709d994da0d7 Mon Sep 17 00:00:00 2001 From: "jesus m. rodriguez" Date: Fri, 24 Jul 2020 12:24:57 -0400 Subject: [PATCH] move zap flags internally --- changelog/fragments/move-log-internally.yaml | 34 ++++++++++++++++++++ cmd/ansible-operator/main.go | 2 +- cmd/helm-operator/main.go | 2 +- {pkg => internal}/log/zap/flags.go | 0 {pkg => internal}/log/zap/flags_test.go | 0 {pkg => internal}/log/zap/logger.go | 0 {pkg => internal}/log/zap/logger_test.go | 0 pkg/ansible/flags/flag.go | 2 +- pkg/helm/flags/flag.go | 2 +- 9 files changed, 38 insertions(+), 4 deletions(-) create mode 100644 changelog/fragments/move-log-internally.yaml rename {pkg => internal}/log/zap/flags.go (100%) rename {pkg => internal}/log/zap/flags_test.go (100%) rename {pkg => internal}/log/zap/logger.go (100%) rename {pkg => internal}/log/zap/logger_test.go (100%) diff --git a/changelog/fragments/move-log-internally.yaml b/changelog/fragments/move-log-internally.yaml new file mode 100644 index 0000000000..e24ccba852 --- /dev/null +++ b/changelog/fragments/move-log-internally.yaml @@ -0,0 +1,34 @@ +# entries is a list of entries to include in +# release notes and/or the migration guide +entries: + - description: > + Moved `pkg/log/zap` to `internal/log/zap`, therefore it is no + longer a public API. + + # kind is one of: + # - addition + # - change + # - deprecation + # - removal + # - bugfix + kind: "removal" + + # Is this a breaking change? + breaking: true + + # NOTE: ONLY USE `pull_request_override` WHEN ADDING THIS + # FILE FOR A PREVIOUSLY MERGED PULL_REQUEST! + # + # The generator auto-detects the PR number from the commit + # message in which this file was originally added. + # + # What is the pull request number (without the "#")? + # pull_request_override: 0 + + + # Migration can be defined to automatically add a section to + # the migration guide. This is required for breaking changes. + migration: + header: pkg/log/zap is no longer a public API + body: > + TBD diff --git a/cmd/ansible-operator/main.go b/cmd/ansible-operator/main.go index 5d97582df4..e1c656e459 100644 --- a/cmd/ansible-operator/main.go +++ b/cmd/ansible-operator/main.go @@ -32,6 +32,7 @@ import ( "sigs.k8s.io/controller-runtime/pkg/manager" "sigs.k8s.io/controller-runtime/pkg/manager/signals" + "github.com/operator-framework/operator-sdk/internal/log/zap" "github.com/operator-framework/operator-sdk/internal/util/k8sutil" "github.com/operator-framework/operator-sdk/pkg/ansible/controller" "github.com/operator-framework/operator-sdk/pkg/ansible/flags" @@ -39,7 +40,6 @@ import ( "github.com/operator-framework/operator-sdk/pkg/ansible/proxy/controllermap" "github.com/operator-framework/operator-sdk/pkg/ansible/runner" "github.com/operator-framework/operator-sdk/pkg/ansible/watches" - "github.com/operator-framework/operator-sdk/pkg/log/zap" sdkVersion "github.com/operator-framework/operator-sdk/version" ) diff --git a/cmd/helm-operator/main.go b/cmd/helm-operator/main.go index aa561126ec..b3b2b0d793 100644 --- a/cmd/helm-operator/main.go +++ b/cmd/helm-operator/main.go @@ -30,12 +30,12 @@ import ( "sigs.k8s.io/controller-runtime/pkg/manager" "sigs.k8s.io/controller-runtime/pkg/manager/signals" + "github.com/operator-framework/operator-sdk/internal/log/zap" "github.com/operator-framework/operator-sdk/internal/util/k8sutil" "github.com/operator-framework/operator-sdk/pkg/helm/controller" "github.com/operator-framework/operator-sdk/pkg/helm/flags" "github.com/operator-framework/operator-sdk/pkg/helm/release" "github.com/operator-framework/operator-sdk/pkg/helm/watches" - "github.com/operator-framework/operator-sdk/pkg/log/zap" sdkVersion "github.com/operator-framework/operator-sdk/version" ) diff --git a/pkg/log/zap/flags.go b/internal/log/zap/flags.go similarity index 100% rename from pkg/log/zap/flags.go rename to internal/log/zap/flags.go diff --git a/pkg/log/zap/flags_test.go b/internal/log/zap/flags_test.go similarity index 100% rename from pkg/log/zap/flags_test.go rename to internal/log/zap/flags_test.go diff --git a/pkg/log/zap/logger.go b/internal/log/zap/logger.go similarity index 100% rename from pkg/log/zap/logger.go rename to internal/log/zap/logger.go diff --git a/pkg/log/zap/logger_test.go b/internal/log/zap/logger_test.go similarity index 100% rename from pkg/log/zap/logger_test.go rename to internal/log/zap/logger_test.go diff --git a/pkg/ansible/flags/flag.go b/pkg/ansible/flags/flag.go index 30795bc1bd..3bbb990b74 100644 --- a/pkg/ansible/flags/flag.go +++ b/pkg/ansible/flags/flag.go @@ -20,7 +20,7 @@ import ( "github.com/spf13/pflag" - "github.com/operator-framework/operator-sdk/pkg/log/zap" + "github.com/operator-framework/operator-sdk/internal/log/zap" ) // Flags - Options to be used by an ansible operator diff --git a/pkg/helm/flags/flag.go b/pkg/helm/flags/flag.go index 6ede9e9385..ec68de5d39 100644 --- a/pkg/helm/flags/flag.go +++ b/pkg/helm/flags/flag.go @@ -20,7 +20,7 @@ import ( "github.com/spf13/pflag" - "github.com/operator-framework/operator-sdk/pkg/log/zap" + "github.com/operator-framework/operator-sdk/internal/log/zap" ) // Flags - Options to be used by a helm operator