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 package description/summary to json output #436

Open
yudong opened this issue Jun 11, 2021 · 2 comments
Open

Add package description/summary to json output #436

yudong opened this issue Jun 11, 2021 · 2 comments
Labels
ecosystem:javascript relating to the javascript ecosystem ecosystem:os relating to an OS packaging ecosystem ecosystem:ruby relating to the ruby ecosystem enhancement New feature or request good-first-issue Good for newcomers I/O Describes bug or enhancement around application input or output

Comments

@yudong
Copy link

yudong commented Jun 11, 2021

What would you like to be added:

Add rpm/gem/npm package description to json output

Why is this needed:
It's a required field for our company's internal SBOM. It might be required by other companies as well.

Additional context:

It would be similar to dnf/yum repoquery -queryformat "%{summary}"

@yudong yudong added the enhancement New feature or request label Jun 11, 2021
@wagoodman
Copy link
Contributor

I think this would be a relatively low lift and add value here 👍 . The goal would be to add these for each ecosystem under the package metadata section (there is a struct type under each syft/pkg/*_metadata.go file that can capture these).

@wagoodman wagoodman added the I/O Describes bug or enhancement around application input or output label Aug 23, 2021
@wagoodman wagoodman added ecosystem:os relating to an OS packaging ecosystem ecosystem:javascript relating to the javascript ecosystem ecosystem:ruby relating to the ruby ecosystem labels Dec 21, 2021
@spiffcs spiffcs added the good-first-issue Good for newcomers label Aug 18, 2022
@spiffcs
Copy link
Contributor

spiffcs commented Aug 18, 2022

We've added this issue as a good first issue for anyone to come in and contribute. If you do pick up this issue I think it's important to have the discussion here on if there is a length limitation to this field, whether it should be on by default, and what are the bounds of implementation so we don't blow up people's outputs by a 10x magnitude in case of a verbose description.

Thanks again for the issue @yudong! We hope we can get this supported in a meaningful way for your company.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
ecosystem:javascript relating to the javascript ecosystem ecosystem:os relating to an OS packaging ecosystem ecosystem:ruby relating to the ruby ecosystem enhancement New feature or request good-first-issue Good for newcomers I/O Describes bug or enhancement around application input or output
Projects
Status: Backlog
Development

No branches or pull requests

3 participants