Remove generated files and update docs to generate files as they were #211
Conversation
openshift-ci
bot
added
the
do-not-merge/work-in-progress
|
Skipping CI for Draft Pull Request. |
cpmeadors
changed the title
openshift-ci
bot
removed
the
do-not-merge/work-in-progress
| @@ -48,7 +48,7 @@ make docker-push | |||
|
|
|||
| ## Building Operator bundle image | |||
| ``` | |||
| make bundle | |||
| make bundle CHANNELS=candidate | |||
There was a problem hiding this comment.
candidate is also what we use in our example subscription in config/samples/deploy, so I think this is a good change
|
Merging is blocked though because CI is failing which seems to be due to missing |
|
What's missing seems to be a |
|
/override |
|
@pmores: /override requires failed status contexts to operate on, but none was given In response to this:
Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository. |
|
/override ci/prow/4.9-ci-index-sandboxed-containers-operator-bundle ci/prow/4.9-images ci/prow/4.9-sandboxed-containers-operator-e2e ci/prow/ci-index-sandboxed-containers-operator-bundle ci/prow/images ci/prow/sandboxed-containers-operator-e2e |
|
@pmores: Overrode contexts on behalf of pmores: ci/prow/4.9-ci-index-sandboxed-containers-operator-bundle, ci/prow/4.9-images, ci/prow/4.9-sandboxed-containers-operator-e2e, ci/prow/ci-index-sandboxed-containers-operator-bundle, ci/prow/images, ci/prow/sandboxed-containers-operator-e2e In response to this:
Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository. |
|
@cpmeadors: all tests passed! Full PR test history. Your PR dashboard. Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository. I understand the commands that are listed here. |
…image Since PR openshift#211, generated files are no longer part of this repo. However, the build process of the main artifact, controller container image, hasn't been adapted to the absence of generated files and currently fails. This change adds generation of generated files to the build process. It does so by replacing the bare `go build` command with a `build` Makefile target invocation. The 'build' target takes care of both file generation (as a prerequisite) and building itself. Several small adjustments are necessary to support running the 'build' target during the controller image build process. Apart from Makefile, also hack/ needs to exist in the builder image as it contains input for the file generator. A COPY command had to be adjusted as `make build` leaves the resulting binary in ./bin instead of ./ . Finally, 'go mod vendor' is used to avoid an "inconsistent vendoring" error. Apparently, 'controller-gen' which runs as part of file generation invokes 'go' internally without passing it the '-mod=mod' flag which effectively disables vendoring. 'go mod vendor' is then a way to bring vendoring into agreement with go.mod.
- Description of the problem which is fixed/What is the use case
There are files being tracked that are completely generated by make targets. Fewer files makes maintaining the code easier.
- What I did
Based on the operator-sdk docs [1], I have deleted the generated files from the repo. One file required an additional command line change to generate the file exactly as it was before deleting. That change was added to the DEVELOPMENT.md file. I also add the relevant entries in the .gitignore to keep the files from being added back.
[1] https://sdk.operatorframework.io/docs/building-operators/golang/tutorial/
This fixes: #209 and #208
- How to verify it
If you execute the make file targets all files that were deleted should be recreated exactly the same:
make docker-build
make bundle
make bundle-build CHANNELS=candidate
- Description for the changelog
Generated files have been deleted from the repo