Skip to content
New issue

Have a question about this project? # for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “#”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? # to your account

[DOCS] Document your CycloneDX properties #1255

Open
jkowalleck opened this issue Dec 11, 2024 · 0 comments
Open

[DOCS] Document your CycloneDX properties #1255

jkowalleck opened this issue Dec 11, 2024 · 0 comments

Comments

@jkowalleck
Copy link

Problem Statement

I see that tern uses CycloneDX properties. like here

"properties": [
{
"name": "tern:repotag",
"value": "photon:3.0"
},
{
"name": "tern:os_guess",
"value": "VMware Photon OS/Linux"
}
],

I would love to see a documentation of the CycloneDX property taxonomy used by tern.
Maybe I just missed it? At least it was not linked in the official registry https://github.com/CycloneDX/cyclonedx-property-taxonomy/blob/ed8a972a5e1c925bba05f8865c1ad3219b872c98/README.md?plain=1#L117

Describe the Proposal

Have the CycloneDX properties documented:

  • property name
  • scope - where the property should be used
  • value space - what the value mean

something similar to https://github.com/CycloneDX/cyclonedx-property-taxonomy/blob/main/cdx.md

Steps to Implement Proposal

I guess, the documentation could be done in a regularly updated file in this repo, or even in this repo's wiki.

After publishing your taxonomy, please link them in the CycloneDX Property taxonomy registry.

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

No branches or pull requests

1 participant