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

Merge generated BOM with services BOM #2175

Merged
merged 2 commits into from Dec 15, 2022

Conversation

nscuro
Copy link
Member

@nscuro nscuro commented Nov 21, 2022

Description

This PR adds an execution of the CycloneDX CLI to the build in order to merge the generated bom.json with the manually-maintained services.bom.json.

The services OSV and Snyk have been added to services.bom.json in order to reflect our new integrations.

Addressed Issue

Relates to #1559
Closes #2125

Additional Details

As the merge step requires the CycloneDX CLI to be installed, it is disabled by default.

In order to keep things simple, generation and distribution of the BOM in XML format is disabled.
Focusing on just the JSON BOM should suffice. Users who need a different format can convert on their end.

Checklist

  • I have read and understand the contributing guidelines
  • This PR fixes a defect, and I have provided tests to verify that the fix is effective
  • This PR implements an enhancement, and I have provided tests to verify that it works as intended
  • This PR introduces changes to the database model, and I have added corresponding update logic
  • This PR introduces new or alters existing behavior, and I have updated the documentation accordingly

This operation required the CycloneDX CLI to be installed and is thus disabled by default. The path to the CLI is customizable using the `cyclonedx-cli.path` property.

Also discontinue distribution of BOM in XML format. Maintaining the BOM in multiple formats only adds overhead.

Signed-off-by: nscuro <nscuro@protonmail.com>
Closes DependencyTrack#2125

Signed-off-by: nscuro <nscuro@protonmail.com>
@nscuro
Copy link
Member Author

nscuro commented Dec 9, 2022

@stevespringett Does this work for you? In particular us not publishing our BOM in XML format anymore.

Copy link
Member

@stevespringett stevespringett left a comment

Choose a reason for hiding this comment

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

LGTM. Thanks @nscuro

@nscuro nscuro merged commit 537ba7d into DependencyTrack:master Dec 15, 2022
@nscuro nscuro deleted the merge-services-bom branch December 15, 2022 09:30
mulder999 pushed a commit to mulder999/dependency-track that referenced this pull request Dec 23, 2022
* Merge generated BOM with services BOM

This operation required the CycloneDX CLI to be installed and is thus disabled by default. The path to the CLI is customizable using the `cyclonedx-cli.path` property.

Also discontinue distribution of BOM in XML format. Maintaining the BOM in multiple formats only adds overhead.

Signed-off-by: nscuro <nscuro@protonmail.com>

* Add services BOM entries for OSV and Snyk

Closes DependencyTrack#2125

Signed-off-by: nscuro <nscuro@protonmail.com>

Signed-off-by: nscuro <nscuro@protonmail.com>
Signed-off-by: mulder999 <nospam099-github@yahoo.com>
@github-actions github-actions bot locked as resolved and limited conversation to collaborators Jan 17, 2023
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Include Snyk and OSV services.bom.json
2 participants