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

I'd like to see the CSV generated with alm-examples attribute in a pretty format #1708

Closed
camilamacedo86 opened this issue Jul 19, 2019 · 5 comments
Assignees
Labels
kind/feature Categorizes issue or PR as related to a new feature. olm-integration Issue relates to the OLM integration

Comments

@camilamacedo86
Copy link
Contributor

camilamacedo86 commented Jul 19, 2019

Feature Request

Is your feature request related to a problem? Please describe.
I have an issue when a CSV is created by the command operator-sdk olm-catalog if I would like to change maintain the alm-examples generated because they are not in a pretty format.

Describe the solution you'd like
Show it in a pretty format in order to improve the Maintenace ability and understatement.

Following an example.

Currently:
Screenshot 2019-07-19 at 12 33 55

As I'd like to check it:
Screenshot 2019-07-19 at 12 34 18

@camilamacedo86 camilamacedo86 changed the title OLM generate CSV with alm-examples in a pretty format I'd like to see the CSV generated with alm-examples in a pretty format Jul 19, 2019
@camilamacedo86 camilamacedo86 changed the title I'd like to see the CSV generated with alm-examples in a pretty format I'd like to see the CSV generated with alm-examples attribute in a pretty format Jul 19, 2019
@camilamacedo86
Copy link
Contributor Author

Hi, @shawn-hurley @jmrodri @hasbro17 @lilic wdyt?

@joelanford
Copy link
Member

@camilamacedo86 I think this is a good idea. We would need to use the "literal style" indicator, which is a pipe (|) for this to work properly. Not sure if our YAML marshaller supports that.

annotations:
  alm-examples: |
    [
        {
            "apiVersion": "mobile-security-service.aerogear.com/v1alpha1"
            ...
        }
    ]

Would you be interested in investigating and submitting a PR?

@camilamacedo86
Copy link
Contributor Author

camilamacedo86 commented Aug 7, 2019

Hi @joelanford,

Sure 👍 . I believe that something like #1793 could work I will be working on it in my spare time and I will let you know when I finish it. :-)

@estroz estroz added kind/feature Categorizes issue or PR as related to a new feature. olm-integration Issue relates to the OLM integration labels Aug 8, 2019
@estroz estroz assigned estroz and unassigned joelanford Aug 8, 2019
@camilamacedo86
Copy link
Contributor Author

Hi @joelanford,

Really tks for your help. It is working now. Please, feel free to review.

@camilamacedo86
Copy link
Contributor Author

Done and merged. 👍

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
kind/feature Categorizes issue or PR as related to a new feature. olm-integration Issue relates to the OLM integration
Projects
None yet
Development

No branches or pull requests

3 participants