docs: add comment explaining how to regenerate constants and table

Signed-off-by: Gareth Jones <[email protected]>
ossf · Nov 4, 2024 · dae0386 · dae0386
1 parent d2a227b
commit dae0386
Show file tree

Hide file tree

Showing 2 changed files with 3 additions and 1 deletion.
diff --git 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
@@ -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:
 
+<!-- (re)generate this list using scripts/update-ecosystems.list.py after changing ecosystems.json -->
 <!-- begin auto-generated ecosystems list -->
 
 | Ecosystem | Description |