Use empty Alm examples #1027
Merged
Use empty Alm examples #1027
Conversation
This file contains 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
Previously with csv-merger we removed the Alm examples in the CSV. This is to save space as our bundles are quite large. Now that we are using the raw data generated by operator-sdk's 'generate bundle' command the config/sample data is getting merged into the generated CSV for openstack-operator. As we had multiple controlplanes in the kustomization.yaml file this meant lots of extra YAML examples which aren't needed. In order to maintain the previous behavior of effectively removing ALM examples, but still passing bundle generate validations this commit creates '_empty.yaml' versions of each CR and then uses those in the kustomization.yaml.
fao89
reviewed
Aug 22, 2024
| @@ -1,11 +1,12 @@ | |||
| ## Append samples you want in your CSV to this file as resources ## | |||
| # NOTE(dprince): these get added to the bundle ALM examples | |||
| # we do not have space for long examples here and want | |||
| # to guide users to documentation instead | |||
There was a problem hiding this comment.
OpenShift UI takes the first CR to prepopulate the UI, do we really want to get everything empty?
There was a problem hiding this comment.
We have always been doing this as csv-merger removed all the alm-examples. This is effectively just restoring that (old) behavior
fao89
approved these changes
Aug 28, 2024
|
[APPROVALNOTIFIER] This PR is APPROVED This pull-request has been approved by: dprince, fao89 The full list of commands accepted by this bot can be found here. The pull request process is described here
Needs approval from an approver in each of these files:
Approvers can indicate their approval by writing |
openshift-merge-bot
bot
merged commit 8bc923a
into
openstack-k8s-operators:main
8 checks passed
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Previously with csv-merger we removed the Alm examples in the CSV. This is to save space as our bundles are quite large.
Now that we are using the raw data generated by operator-sdk's 'generate bundle' command the config/sample data is getting merged into the generated CSV for openstack-operator. As we had multiple controlplanes in the kustomization.yaml file this meant lots of extra YAML examples which aren't needed.
In order to maintain the previous behavior of effectively removing ALM examples, but still passing bundle generate validations this commit creates '_empty.yaml' versions of each CR and then uses those in the kustomization.yaml.