From 55065b852f63c52ebea19ce1b3faa52eca6e3b1e Mon Sep 17 00:00:00 2001 From: Gareth Jones Date: Tue, 5 Nov 2024 08:07:01 +1300 Subject: [PATCH] docs: add comment explaining how to regenerate constants and table Signed-off-by: Gareth Jones --- bindings/go/osvschema/constants.go | 1 + docs/schema.md | 3 ++- 2 files changed, 3 insertions(+), 1 deletion(-) diff --git a/bindings/go/osvschema/constants.go b/bindings/go/osvschema/constants.go index 4dfdea9..7cbae4c 100644 --- a/bindings/go/osvschema/constants.go +++ b/bindings/go/osvschema/constants.go @@ -2,6 +2,7 @@ package osvschema type Ecosystem string +// this list is generated by scripts/update-ecosystems-lists.py const ( EcosystemAlmaLinux Ecosystem = "AlmaLinux" EcosystemAlpine Ecosystem = "Alpine" diff --git a/docs/schema.md b/docs/schema.md index fca0393..6f90671 100644 --- a/docs/schema.md +++ b/docs/schema.md @@ -668,7 +668,7 @@ within its ecosystem. The two fields must both be present, because the The `purl` field is a string following the [Package URL specification](https://github.com/package-url/purl-spec) that identifies the package, without the `@version` component. -This field is optional but recommended. +This field is optional but recommended. Different ecosystems can define the same names; they identify different packages. For example, these denote different libraries with different sets of @@ -686,6 +686,7 @@ versions and different potential vulnerabilities: The defined ecosystems are: + | Ecosystem | Description |