- Notifications
You must be signed in to change notification settings - Fork 1.8k
upgrade kb and controller-runtime dep version #4062
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
upgrade kb and controller-runtime dep version #4062
Conversation
estroz left a comment
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 think we need to have a discussion about how the changelog refers to upstream bugfixes that the SDK receives through dep bumps.
My opinion: we shouldn't be making changelog entries for upstream bug fixes unless there is an issue filed in the SDK repo (unless it is serious enough to precipitate here), or if a migration is needed. All of these bugs and their fixes are already documented upstream. If we decide to document bugfixes in the SDK changelog, then we can't be selective about which ones we document and must document all bugfixes.
/cc @jmrodri @joelanford
joelanford left a comment
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 generally agree with @estroz, but I would propose a perhaps reasonable middle ground: If we make a dependency bump that will have user-facing changes, we have a simple changelog entry that says something along the lines of
Bumped dependency A to
vX.Y.Z. See <link> for details.
Where <link> is a link to the github release or changelog notes or whatever other doc documents that release.
| Hi @joelanford,
Currently, we cannot do that because we still bumping the commits which indeed is my motivation here. Note that after we do a kb release and start to have more actively releases from there we will be able to achieve the goal in this way. Now, it is better we keep both aligned as much as possible otherwise will be hard we know what changes from the commit X to the commit Y. |
| Ah I see. Since we're currently pinning to a random commit on master, there isn't a pretty release page or changelog. Could we link instead to a commit range? I think GitHub handles that nicely. |
changelog/fragments/upgrade-kb.yaml Outdated
| 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`. |
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 about operator-sdk binary dependency changes (those that are not scaffolded) unless they affect commands that have a runtime (ex. k8s versions).
How about
| Upgrade the Kubebuilder CLI dependecy version from `f7a3b65dd250` to `c993a2a221fe`. | |
| Fix scaffolded (multi-group only) `controllers/<group>/suite_test.go` to have | |
| a correct `envtest.Environment.CRDDirectoryPaths` ([kubebuilder#1665](https://github.com/kubernetes-sigs/kubebuilder/pull/1665)). |
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-sdk binary uses, or whether a scaffold fix occurred? You can still link the commit range without discussing it.
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-sdk binary uses, or whether a scaffold fix occurred?
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
You can still link the commit range without discussing it.
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?
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.
| @camilamacedo86 It looks like you ran Also @varshaprasad96 @estroz we may want to use this fork: https://github.com/kevinburke/go-bindata It seems to have more frequent maintenance, is the fork used for One of the improvements is that it automatically go fmts the output it produces which I think would have resolved the error that @camilamacedo86 has with the changes to this file in this PR. |
| Hi @joelanford,
We cannot use the go fmt in the bindata. See: https://travis-ci.org/github/operator-framework/operator-sdk/jobs/737366995#L1335-L1342. IHMO
|
| @camilamacedo86 Why does this PR have any changes to
Neither
I disagree, we should make sure all of our committed code is formatted correctly with
Don't think this is related to the issue. |
go.mod Outdated
| golang.org/x/lint v0.0.0-20200302205851-738671d3881b // indirect | ||
| golang.org/x/tools v0.0.0-20201019175715-b894a3290fff |
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.
These lines appear to be caused by running make bindata and should be reverted.
@varshaprasad96 we should update the bindata generation script to make sure it does not cause side effects like this.
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.
It is the go.mod of the project.
See that it still as it is and passing in the CI after we revert the changes made via the make fix on the bindata.
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.
However, I reverted that I executed go mod tidy.
estroz left a comment
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
| @joelanford since our discussions here were only over the fragment and all suggestions made were addressed it shows fine to get merged. if you wish, we can change some word in a follow up as well. |
Description of the change:
v0.6.2tov0.6.3. More info: https://github.com/kubernetes-sigs/controller-runtime/releases/tag/v0.6.3Motivation for the change:
Checklist
If the pull request includes user-facing changes, extra documentation is required:
changelog/fragments(seechangelog/fragments/00-template.yaml)website/content/en/docs