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

Promote cataloging task pattern #554

Closed
wagoodman opened this issue Oct 16, 2021 · 2 comments · Fixed by #636
Closed

Promote cataloging task pattern #554

wagoodman opened this issue Oct 16, 2021 · 2 comments · Fixed by #636
Assignees
Labels
enhancement New feature or request
Milestone

Comments

@wagoodman
Copy link
Contributor

wagoodman commented Oct 16, 2021

Today the package command is a single task that is responsible for invoking all of the package catalogers and returning a presenter capable of encoding an SBOM in a particular format.

At the same time, the power-user command can enable and disable different catalogers and format the SBOM document more dynamically. Internally the power-user command is made of a set of tasks that is dynamic based on the configuration. Additionally, all tasks write to a single result document instance, encapsulating all possible things that can be cataloged.

There are elements of the internal power-user command approach that would be ideal to promote forward as patterns we want to see on the package command (or any command that will do cataloging in the future).

Goals:

  1. Have a singular analysis result document to encapsulate all things discovered. Possibly a new sbom package with a struct called Document. (tracked in Encapsulate all artifacts in syft JSON output #555)
  2. Move towards a task-based approach for separating work and attaching the result to the analysis document

These goals focus on how the work of cataloging is completed and persisting in a programmatic way that is useful to others.

@spiffcs
Copy link
Contributor

spiffcs commented Nov 2, 2021

Dependent on review of #606. When that is in then we can start building tasks around the package command that talk to this new document.

@spiffcs
Copy link
Contributor

spiffcs commented Nov 5, 2021

Grabbing this while waiting for a review on our new media type.

@spiffcs spiffcs removed their assignment Nov 8, 2021
@spiffcs spiffcs linked a pull request Nov 18, 2021 that will close this issue
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants