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

Extend ABOUT files to support products #557

Open
4 tasks
pombredanne opened this issue May 1, 2024 · 2 comments
Open
4 tasks

Extend ABOUT files to support products #557

pombredanne opened this issue May 1, 2024 · 2 comments

Comments

@pombredanne
Copy link
Member

I would like to add a new "is_product" attribute so we can track a ABOUT file in SCIO and SCTK as being for a DejaCode product.
With this we will be able to know that a scan in SCIO or SCTK is for a specific product and use this information when uploading to DejaCode

  • Add support for ABOUT file "is_product" in AboutCode toolkit
  • Add support for ABOUT file "is_product" in ScanCode toolkit
  • Add support for ABOUT file "is_product" in ScanCode.io
  • Add support for ABOUT file "is_product" in DejaCode

Here is how a minimal product ABOUT file could look like:

about_resource: .
is_product: yes
name: My Super Product
version: 1.0
description: Short description
homepage_url: https://internal/super-product/home.html

It could contain of course more details, like VCS repos references, author team pointers, etc.
The ABOUT spec is at https://github.com/nexB/aboutcode-toolkit/blob/develop/docs/source/specification.rst

The name would map to a product name in DejaCode.

@chinyeungli
Copy link
Contributor

chinyeungli commented May 2, 2024

@pombredanne just to verify the is_product attribute is a boolean value, correct?
In addition, can you draft a formal description of what is_product is so that the spec can be updated?

@mjherzog
Copy link
Member

mjherzog commented May 2, 2024

There are certainly use cases where the is_product field would need to allow multiple values because you use code from a repo in multiple products.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants