Uploaded image for project: 'Red Hat Internal Developer Platform'
  1. Red Hat Internal Developer Platform
  2. RHIDP-6183

Create marketplace-cli subcommand to generate CSV files from YAML files

    • Icon: Story Story
    • Resolution: Done
    • Icon: Normal Normal
    • 1.6.0
    • None
    • Marketplace
    • 3
    • False
    • Hide

      None

      Show
      None
    • False

      EPIC Goal

      Create a CLI tool to export a list of local YAML files into a CSV file.

      Background/Feature Origin

      This tool is for product management consumption in Google Sheets.

      We might need two slightly different formats.

      Why is this important?

      It's needed have a single source of truth for the marketplace data and options to export these data for other teams and tools (like catalog.redhat.com and others) that can read CSV easier then YAML files.

      User Scenarios

      1. A user and CI job want export the marketplace YAML files as CSV file

      Dependencies (internal and external)

      None

      Acceptance Criteria

      1. There should be a new sub-command of the marketplace-cli
      2. It should accepts multiple YAML files (or a glob) as input and should use stdout or a file as output. All files can be expected to be local files.
      3. The output should be generated with a CSV library and the output should tested at least with Google Spreadsheet.
      4. The tool should find the relations between Plugins and Packages by their name.
      5. The command should report a Warning to the terminal if a relation is missing. It should also return an error code. I expect that it would be nice to export the rest of the plugins anyway.
      6. The export should expect that some columns contains multiline-text!
      7. The exact format should be checked or discussed with Christophe or Marcel

      Until we have an extract requirement we can start or expect something like this.

      1. Plugin name (metadata.name)
      2. Plugin title (metadata.title)
      3. Plugin short description (metadata.description)
      4. Plugin full description (spec.description)
      5. Plugin installation (spec.installation)
      6. Plugin support level
      7. Frontend package name
      8. Frontend package version
      9. Backend package name
      10. Backend package version
      11. Other related packages (a list of all plugins where its unclear if its a frontend or backend)

      *https://github.com/redhat-developer/rhdh-plugins/tree/main/workspaces/marketplace/packages/cli

              rh-ee-jaclee Jackson Lee
              cjerolim Christoph Jerolimov
              RHIDP - Frontend Plugins & UI
              Votes:
              0 Vote for this issue
              Watchers:
              2 Start watching this issue

                Created:
                Updated:
                Resolved: