Skip to content
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

Add missing information to CSV #163

Merged
merged 1 commit into from
Dec 11, 2023
Merged

Add missing information to CSV #163

merged 1 commit into from
Dec 11, 2023

Conversation

grzpiotrowski
Copy link
Contributor

@grzpiotrowski grzpiotrowski commented Dec 5, 2023

This PR attempts to fix #162.

It looks like adding the information to the CSV template sorts out the issue of missing names/descriptions.

There is one peculiar thing caused by two versions of AuthConfig CRD which results in two seemingly duplicated cards rendered in OperatorHub.

While the displayed name could be altered so the first card would display for example AuthConfig/v1beta1 and the second card AuthConfig/v1beta2 the YAML example displayed on both cards would still show an example from AuthConfig/v1beta2 (even for v1beta1 card), despite examples existing for both versions in the CSV file. It's a bit confusing, I hope this describes the issue in an understandable way.

For this reason I have included the example YAML for AuthConfig/v1beta2 only and kept the displayName for both versions as AuthConfig. This way the OperatorHub will only show the most recent version to the visitors with a correct YAML example.

As an example, this approach can be also seen in ArgoCD operator with the Argo CD schema.

To verify the changes, copy the full contents of the generated CSV manifest to OperatorHub Preview tool.

Also a pic of how it looks like after the changes:
image

@alexsnaps alexsnaps added this to the v0.11.x milestone Dec 8, 2023
@grzpiotrowski grzpiotrowski marked this pull request as ready for review December 11, 2023 12:13
@grzpiotrowski grzpiotrowski requested a review from a team December 11, 2023 12:14
Copy link
Collaborator

@guicassolato guicassolato left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice! Thanks, @grzpiotrowski!

@grzpiotrowski grzpiotrowski merged commit f026ef8 into main Dec 11, 2023
8 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Archived in project
Status: To test
Development

Successfully merging this pull request may close these issues.

Missing AuthConfig v1beta2 display name and description in the CSV
4 participants