dejacode icon indicating copy to clipboard operation
dejacode copied to clipboard

Provide ability to Import an ABOUT file into DejaCode

Open DennisClark opened this issue 1 year ago • 1 comments

See related issue #42

DejaCode currently provides a simple and convenient interface that enables a user to generate an ABOUT file (and associated files) for a Package or Component; however, the direction is only outbound from DejaCode.

Consider enhancing DejaCode to support the ability to import an ABOUT file, with the result being either the creation of a new Package or updates to a Package already defined in DejaCode.

  • Note that the PURL of a DejaCode Package is (must be) exactly the same as the PURL in a corresponding ABOUT file (perhaps obvious but worth emphasizing).
  • It might also make sense for this proposed Import process to query the PurlDB to find and use any additional useful details that could be useful when creating a new Package, but are not provided in the ABOUT file being imported.

Once the import is completed, then the DejaCode user would be able to see all the Package details in the standard DejaCode details view, and also reproduced in the ABOUT tab.

DennisClark avatar Feb 05 '24 23:02 DennisClark

Note that an ABOUT file "bundle" may include:

  • a .ABOUT file
  • a .NOTICE file
  • one or more .LICENSE file(s)

The .NOTICE file generally contains important details about a Package, especially regarding its copyright and license terms. The text of the .NOTICE file should be copied into a DejaCode Package definition when available.

DennisClark avatar Feb 05 '24 23:02 DennisClark

@DennisClark you can already import .ABOUT file into DejaCode using the "Load Packages from SBOMs" Product feature:

Screenshot 2024-05-28 at 10 06 24

Note that you can provide multiple .ABOUT files into a zip archive (along with any other supported SBOMs) or provide a single .ABOUT file.

Please have a look at the existing feature and let me know if anything else is needed.

tdruez avatar May 28 '24 06:05 tdruez

@tdruez thanks for pointing out the existing feature, which I have confirmed as working just fine.

DennisClark avatar May 28 '24 15:05 DennisClark