✨ OPRUN-3763: Consolidate APIs into the same directory #1803
Conversation
✅ Deploy Preview for olmv1 ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
This required renaming op-con's CatalogSource to CatalogFilter to avoid a name conflict with catd's CatalogSource Update source files to refer to the proper API directory, and name the import reference consistently. The docs/api-reference is now combined as well. Signed-off-by: Todd Short <tshort@redhat.com>
Codecov ReportAttention: Patch coverage is
Additional details and impacted files@@ Coverage Diff @@
## main #1803 +/- ##
==========================================
+ Coverage 68.34% 68.39% +0.05%
==========================================
Files 63 62 -1
Lines 5117 5117
==========================================
+ Hits 3497 3500 +3
+ Misses 1390 1388 -2
+ Partials 230 229 -1
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. |
|
/hold |
| mkdir $(CRD_WORKING_DIR) | ||
| $(CONTROLLER_GEN) crd paths="./api/v1/..." output:crd:artifacts:config=$(CRD_WORKING_DIR) | ||
| mv $(CRD_WORKING_DIR)/olm.operatorframework.io_clusterextensions.yaml $(KUSTOMIZE_OPCON_CRDS_DIR) | ||
| mv $(CRD_WORKING_DIR)/olm.operatorframework.io_clustercatalogs.yaml $(KUSTOMIZE_CATD_CRDS_DIR) |
There was a problem hiding this comment.
We are not deleting the older files in KUSTOMIZE_OPCON_CRDS_DIR and expecting to override the olderfiles with the new ones. It should work but it is not a full proof method. Also assuming we will not change the file names in future.
There was a problem hiding this comment.
Correct, we are not deleting the files. It's not strictly necessary, since the mv will overwrite existing files. And given that these are our CRDs, and that controller-gen uses a name specific format, I think we're ok. The only way we'd change the filenames is if we change the CRDs, which would make them incompatible.
| @@ -1,5 +1,5 @@ | |||
| /* | |||
| Copyright 2022. | |||
| Copyright 2024. | |||
There was a problem hiding this comment.
Is it necessary to change the Copyright year?
There was a problem hiding this comment.
Found https://stackoverflow.com/questions/2390230/do-copyright-dates-need-to-be-updated, So I think we should change it to 2025?
There was a problem hiding this comment.
It's actually a new file, but git thinks it's a rename of api/catalogd/doc.go...
And you're right, it ought to be 2025
There was a problem hiding this comment.
We don't have a copyright policy... something we may want to talk about in one of our meetings.
|
/hold cancel |
4ecef20
This required renaming op-con's CatalogSource to CatalogFilter to avoid a name conflict with catd's CatalogSource
Update source files to refer to the proper API directory, and name the import reference consistently.
The docs/api-reference is now combined as well.
Description
Reviewer Checklist