upgrade kb and controller-runtime dep version #4062
+71 −15
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters. Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,56 @@ | ||
| # entries is a list of entries to include in | ||
| # release notes and/or the migration guide | ||
| entries: | ||
| - description: > | ||
| Upgrade sigs.k8s.io/controller-runtime dependency version from `v0.6.2` to | ||
| [`v0.6.3`](https://github.com/kubernetes-sigs/controller-runtime/releases/tag/v0.6.3). | ||
| # kind is one of: | ||
| # - addition | ||
| # - change | ||
| # - deprecation | ||
| # - removal | ||
| # - bugfix | ||
| kind: "change" | ||
| # Is this a breaking change? | ||
| breaking: false | ||
| # Migration can be defined to automatically add a section to | ||
| # the migration guide. This is required for breaking changes. | ||
| migration: | ||
| header: (Golang based operators) Upgrade sigs.k8s.io/controller-runtime version to v0.6.3 | ||
| body: > | ||
| In the `go.mod` file replace `sigs.k8s.io/controller-runtime v0.6.2` | ||
| with `sigs.k8s.io/controller-runtime v0.6.3` and then run `go mod tidy`. | ||
| - description: > | ||
| Upgrade the Kubebuilder CLI dependecy version from `f7a3b65dd250` to `c993a2a221fe`. | ||
| More info: https://github.com/kubernetes-sigs/kubebuilder/compare/f7a3b65dd250..c993a2a221fe | ||
| # kind is one of: | ||
| # - addition | ||
| # - change | ||
| # - deprecation | ||
| # - removal | ||
| # - bugfix | ||
| kind: "change" | ||
| # Is this a breaking change? | ||
| breaking: false | ||
| # Migration can be defined to automatically add a section to | ||
| # the migration guide. This is required for breaking changes. | ||
| migration: | ||
| header: (Golang based operators with multigroup support) Fix `CRDDirectoryPath` in `controllers/<group>/suite_test.go` | ||
| body: > | ||
| If your project is multi-group, then replace | ||
| `CRDDirectoryPaths: []string{filepath.Join("..", "config", "crd", "bases")},` with | ||
| `CRDDirectoryPaths: []string{filepath.Join("..", "..", "config", "crd", "bases")},` | ||
| in `suite_test.go` files found in `controllers/<group>/` directories. Otherwise, the tests will fail since | ||
| this EnvTest will not be looking for the CRD's in the correct location. For more info, see | ||
| [kubebuilder#1665](https://github.com/kubernetes-sigs/kubebuilder/issues/1665). | ||
| **NOTE** To check if your project has multigroup support ensure that | ||
| your PROJECT file has the `multigroup: true` attribute. | ||
camilamacedo86 marked this conversation as resolved. Outdated Show resolved Hide resolved | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters. Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| | @@ -22,7 +22,8 @@ require ( | |
| github.com/spf13/pflag v1.0.5 | ||
| github.com/spf13/viper v1.4.0 | ||
| github.com/stretchr/testify v1.6.1 | ||
| golang.org/x/lint v0.0.0-20200302205851-738671d3881b // indirect | ||
| golang.org/x/tools v0.0.0-20201019175715-b894a3290fff | ||
| ||
| gomodules.xyz/jsonpatch/v3 v3.0.1 | ||
| helm.sh/helm/v3 v3.3.4 | ||
| k8s.io/api v0.18.8 | ||
| | @@ -32,9 +33,9 @@ require ( | |
| k8s.io/client-go v0.18.8 | ||
| k8s.io/kubectl v0.18.8 | ||
| rsc.io/letsencrypt v0.0.3 // indirect | ||
| sigs.k8s.io/controller-runtime v0.6.3 | ||
| sigs.k8s.io/controller-tools v0.3.0 | ||
| sigs.k8s.io/kubebuilder v1.0.9-0.20201014221150-c993a2a221fe | ||
| sigs.k8s.io/yaml v1.2.0 | ||
| ) | ||
| | ||
| | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters. Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters. Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters. Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters. Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit. This suggestion is invalid because no changes were made to the code. Suggestions cannot be applied while the pull request is closed. Suggestions cannot be applied while viewing a subset of changes. Only one suggestion per line can be applied in a batch. Add this suggestion to a batch that can be applied as a single commit. Applying suggestions on deleted lines is not supported. You must change the existing code in this line in order to create a valid suggestion. Outdated suggestions cannot be applied. This suggestion has been applied or marked resolved. Suggestions cannot be applied from pending reviews. Suggestions cannot be applied on multi-line comments. Suggestions cannot be applied while the pull request is queued to merge. Suggestion cannot be applied right now. Please check back later.
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.
Operator projects don't directly depend on
kubebuilder, so this is rather confusing. We probably don't need to notify users aboutoperator-sdkbinary dependency changes (those that are not scaffolded) unless they affect commands that have a runtime (ex. k8s versions).How about
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.
Then, we came back for the first version of this PR where all changes/bugfixes that impact the end-user was described on it. see: 59cb168
Note that it was a suggestion made by @joelanford
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.
Do you think users care about what version of kubebuilder the
operator-sdkbinary uses, or whether a scaffold fix occurred? You can still link the commit range without discussing it.Uh oh!
There was an error while loading. Please reload this page.
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.
I do not think so. Because of this my first version of this PR just add fragment for all bugfixes changes that are visible to the SDK end-users
What is your suggestion? How do you think that we can do that?
I am totally open mind here. I just try to avoid back an forwards as for example, are we ok to come back it to the original idea? Or what are your thoughts?
Uh oh!
There was an error while loading. Please reload this page.
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.
I applied your suggestion specifically. I am OK with too.