From 68da6614dca4182cbd1c070bac527477cf23dcdb Mon Sep 17 00:00:00 2001 From: Jan Kowalleck Date: Mon, 10 Aug 2026 19:58:05 +0200 Subject: [PATCH 1/4] chore: split docs CDX1.x Signed-off-by: Jan Kowalleck --- .github/workflows/{build_docs.yml => build_1.x_docs.yml} | 8 ++++---- docgen/{ => schema-v1}/json/.gitignore | 0 docgen/{ => schema-v1}/json/gen.sh | 0 docgen/{ => schema-v1}/json/requirements.txt | 0 .../json/templates/cyclonedx/badge_type.html | 0 docgen/{ => schema-v1}/json/templates/cyclonedx/base.html | 0 .../json/templates/cyclonedx/breadcrumbs.html | 0 .../{ => schema-v1}/json/templates/cyclonedx/content.html | 0 .../json/templates/cyclonedx/macro_restriction.html | 0 .../json/templates/cyclonedx/schema_doc.css | 0 .../json/templates/cyclonedx/schema_doc.js | 0 .../json/templates/cyclonedx/schema_doc.min.js | 0 .../json/templates/cyclonedx/section_array.html | 0 .../cyclonedx/section_conditional_subschema.html | 0 .../json/templates/cyclonedx/section_description.html | 0 .../json/templates/cyclonedx/section_examples.html | 0 .../json/templates/cyclonedx/section_not.html | 0 .../json/templates/cyclonedx/section_properties.html | 0 .../section_undocumented_required_properties.html | 0 .../json/templates/cyclonedx/tabbed_section.html | 0 docgen/{ => schema-v1}/proto/.gitignore | 0 docgen/{ => schema-v1}/proto/gen.sh | 0 docgen/{ => schema-v1}/proto/templates/html.tmpl | 0 docgen/{ => schema-v1}/static/generate-menu.py | 0 docgen/{ => schema-v1}/static/header.html | 0 docgen/{ => schema-v1}/static/inject-header.sh | 0 docgen/{ => schema-v1}/static/releases.json | 0 docgen/{ => schema-v1}/xml/.gitignore | 0 docgen/{ => schema-v1}/xml/gen.sh | 0 docgen/{ => schema-v1}/xml/xs3p.xsl | 0 30 files changed, 4 insertions(+), 4 deletions(-) rename .github/workflows/{build_docs.yml => build_1.x_docs.yml} (93%) rename docgen/{ => schema-v1}/json/.gitignore (100%) rename docgen/{ => schema-v1}/json/gen.sh (100%) rename docgen/{ => schema-v1}/json/requirements.txt (100%) rename docgen/{ => schema-v1}/json/templates/cyclonedx/badge_type.html (100%) rename docgen/{ => schema-v1}/json/templates/cyclonedx/base.html (100%) rename docgen/{ => schema-v1}/json/templates/cyclonedx/breadcrumbs.html (100%) rename docgen/{ => schema-v1}/json/templates/cyclonedx/content.html (100%) rename docgen/{ => schema-v1}/json/templates/cyclonedx/macro_restriction.html (100%) rename docgen/{ => schema-v1}/json/templates/cyclonedx/schema_doc.css (100%) rename docgen/{ => schema-v1}/json/templates/cyclonedx/schema_doc.js (100%) rename docgen/{ => schema-v1}/json/templates/cyclonedx/schema_doc.min.js (100%) rename docgen/{ => schema-v1}/json/templates/cyclonedx/section_array.html (100%) rename docgen/{ => schema-v1}/json/templates/cyclonedx/section_conditional_subschema.html (100%) rename docgen/{ => schema-v1}/json/templates/cyclonedx/section_description.html (100%) rename docgen/{ => schema-v1}/json/templates/cyclonedx/section_examples.html (100%) rename docgen/{ => schema-v1}/json/templates/cyclonedx/section_not.html (100%) rename docgen/{ => schema-v1}/json/templates/cyclonedx/section_properties.html (100%) rename docgen/{ => schema-v1}/json/templates/cyclonedx/section_undocumented_required_properties.html (100%) rename docgen/{ => schema-v1}/json/templates/cyclonedx/tabbed_section.html (100%) rename docgen/{ => schema-v1}/proto/.gitignore (100%) rename docgen/{ => schema-v1}/proto/gen.sh (100%) rename docgen/{ => schema-v1}/proto/templates/html.tmpl (100%) rename docgen/{ => schema-v1}/static/generate-menu.py (100%) rename docgen/{ => schema-v1}/static/header.html (100%) rename docgen/{ => schema-v1}/static/inject-header.sh (100%) rename docgen/{ => schema-v1}/static/releases.json (100%) rename docgen/{ => schema-v1}/xml/.gitignore (100%) rename docgen/{ => schema-v1}/xml/gen.sh (100%) rename docgen/{ => schema-v1}/xml/xs3p.xsl (100%) diff --git a/.github/workflows/build_docs.yml b/.github/workflows/build_1.x_docs.yml similarity index 93% rename from .github/workflows/build_docs.yml rename to .github/workflows/build_1.x_docs.yml index 3c4377c86..2e7781be1 100644 --- a/.github/workflows/build_docs.yml +++ b/.github/workflows/build_1.x_docs.yml @@ -1,4 +1,4 @@ -name: Build Docs +name: Build CDX-1.x Docs on: push: @@ -17,7 +17,7 @@ jobs: runs-on: ubuntu-latest defaults: run: - working-directory: docgen/xml + working-directory: docgen/schema-v1/xml steps: - name: Checkout # see https://github.com/actions/checkout @@ -44,7 +44,7 @@ jobs: runs-on: ubuntu-latest defaults: run: - working-directory: docgen/json + working-directory: docgen/schema-v1/json steps: - name: Checkout # see https://github.com/actions/checkout @@ -70,7 +70,7 @@ jobs: runs-on: ubuntu-latest defaults: run: - working-directory: docgen/proto + working-directory: docgen/schema-v1/proto steps: - name: Checkout # see https://github.com/actions/checkout diff --git a/docgen/json/.gitignore b/docgen/schema-v1/json/.gitignore similarity index 100% rename from docgen/json/.gitignore rename to docgen/schema-v1/json/.gitignore diff --git a/docgen/json/gen.sh b/docgen/schema-v1/json/gen.sh similarity index 100% rename from docgen/json/gen.sh rename to docgen/schema-v1/json/gen.sh diff --git a/docgen/json/requirements.txt b/docgen/schema-v1/json/requirements.txt similarity index 100% rename from docgen/json/requirements.txt rename to docgen/schema-v1/json/requirements.txt diff --git a/docgen/json/templates/cyclonedx/badge_type.html b/docgen/schema-v1/json/templates/cyclonedx/badge_type.html similarity index 100% rename from docgen/json/templates/cyclonedx/badge_type.html rename to docgen/schema-v1/json/templates/cyclonedx/badge_type.html diff --git a/docgen/json/templates/cyclonedx/base.html b/docgen/schema-v1/json/templates/cyclonedx/base.html similarity index 100% rename from docgen/json/templates/cyclonedx/base.html rename to docgen/schema-v1/json/templates/cyclonedx/base.html diff --git a/docgen/json/templates/cyclonedx/breadcrumbs.html b/docgen/schema-v1/json/templates/cyclonedx/breadcrumbs.html similarity index 100% rename from docgen/json/templates/cyclonedx/breadcrumbs.html rename to docgen/schema-v1/json/templates/cyclonedx/breadcrumbs.html diff --git a/docgen/json/templates/cyclonedx/content.html b/docgen/schema-v1/json/templates/cyclonedx/content.html similarity index 100% rename from docgen/json/templates/cyclonedx/content.html rename to docgen/schema-v1/json/templates/cyclonedx/content.html diff --git a/docgen/json/templates/cyclonedx/macro_restriction.html b/docgen/schema-v1/json/templates/cyclonedx/macro_restriction.html similarity index 100% rename from docgen/json/templates/cyclonedx/macro_restriction.html rename to docgen/schema-v1/json/templates/cyclonedx/macro_restriction.html diff --git a/docgen/json/templates/cyclonedx/schema_doc.css b/docgen/schema-v1/json/templates/cyclonedx/schema_doc.css similarity index 100% rename from docgen/json/templates/cyclonedx/schema_doc.css rename to docgen/schema-v1/json/templates/cyclonedx/schema_doc.css diff --git a/docgen/json/templates/cyclonedx/schema_doc.js b/docgen/schema-v1/json/templates/cyclonedx/schema_doc.js similarity index 100% rename from docgen/json/templates/cyclonedx/schema_doc.js rename to docgen/schema-v1/json/templates/cyclonedx/schema_doc.js diff --git a/docgen/json/templates/cyclonedx/schema_doc.min.js b/docgen/schema-v1/json/templates/cyclonedx/schema_doc.min.js similarity index 100% rename from docgen/json/templates/cyclonedx/schema_doc.min.js rename to docgen/schema-v1/json/templates/cyclonedx/schema_doc.min.js diff --git a/docgen/json/templates/cyclonedx/section_array.html b/docgen/schema-v1/json/templates/cyclonedx/section_array.html similarity index 100% rename from docgen/json/templates/cyclonedx/section_array.html rename to docgen/schema-v1/json/templates/cyclonedx/section_array.html diff --git a/docgen/json/templates/cyclonedx/section_conditional_subschema.html b/docgen/schema-v1/json/templates/cyclonedx/section_conditional_subschema.html similarity index 100% rename from docgen/json/templates/cyclonedx/section_conditional_subschema.html rename to docgen/schema-v1/json/templates/cyclonedx/section_conditional_subschema.html diff --git a/docgen/json/templates/cyclonedx/section_description.html b/docgen/schema-v1/json/templates/cyclonedx/section_description.html similarity index 100% rename from docgen/json/templates/cyclonedx/section_description.html rename to docgen/schema-v1/json/templates/cyclonedx/section_description.html diff --git a/docgen/json/templates/cyclonedx/section_examples.html b/docgen/schema-v1/json/templates/cyclonedx/section_examples.html similarity index 100% rename from docgen/json/templates/cyclonedx/section_examples.html rename to docgen/schema-v1/json/templates/cyclonedx/section_examples.html diff --git a/docgen/json/templates/cyclonedx/section_not.html b/docgen/schema-v1/json/templates/cyclonedx/section_not.html similarity index 100% rename from docgen/json/templates/cyclonedx/section_not.html rename to docgen/schema-v1/json/templates/cyclonedx/section_not.html diff --git a/docgen/json/templates/cyclonedx/section_properties.html b/docgen/schema-v1/json/templates/cyclonedx/section_properties.html similarity index 100% rename from docgen/json/templates/cyclonedx/section_properties.html rename to docgen/schema-v1/json/templates/cyclonedx/section_properties.html diff --git a/docgen/json/templates/cyclonedx/section_undocumented_required_properties.html b/docgen/schema-v1/json/templates/cyclonedx/section_undocumented_required_properties.html similarity index 100% rename from docgen/json/templates/cyclonedx/section_undocumented_required_properties.html rename to docgen/schema-v1/json/templates/cyclonedx/section_undocumented_required_properties.html diff --git a/docgen/json/templates/cyclonedx/tabbed_section.html b/docgen/schema-v1/json/templates/cyclonedx/tabbed_section.html similarity index 100% rename from docgen/json/templates/cyclonedx/tabbed_section.html rename to docgen/schema-v1/json/templates/cyclonedx/tabbed_section.html diff --git a/docgen/proto/.gitignore b/docgen/schema-v1/proto/.gitignore similarity index 100% rename from docgen/proto/.gitignore rename to docgen/schema-v1/proto/.gitignore diff --git a/docgen/proto/gen.sh b/docgen/schema-v1/proto/gen.sh similarity index 100% rename from docgen/proto/gen.sh rename to docgen/schema-v1/proto/gen.sh diff --git a/docgen/proto/templates/html.tmpl b/docgen/schema-v1/proto/templates/html.tmpl similarity index 100% rename from docgen/proto/templates/html.tmpl rename to docgen/schema-v1/proto/templates/html.tmpl diff --git a/docgen/static/generate-menu.py b/docgen/schema-v1/static/generate-menu.py similarity index 100% rename from docgen/static/generate-menu.py rename to docgen/schema-v1/static/generate-menu.py diff --git a/docgen/static/header.html b/docgen/schema-v1/static/header.html similarity index 100% rename from docgen/static/header.html rename to docgen/schema-v1/static/header.html diff --git a/docgen/static/inject-header.sh b/docgen/schema-v1/static/inject-header.sh similarity index 100% rename from docgen/static/inject-header.sh rename to docgen/schema-v1/static/inject-header.sh diff --git a/docgen/static/releases.json b/docgen/schema-v1/static/releases.json similarity index 100% rename from docgen/static/releases.json rename to docgen/schema-v1/static/releases.json diff --git a/docgen/xml/.gitignore b/docgen/schema-v1/xml/.gitignore similarity index 100% rename from docgen/xml/.gitignore rename to docgen/schema-v1/xml/.gitignore diff --git a/docgen/xml/gen.sh b/docgen/schema-v1/xml/gen.sh similarity index 100% rename from docgen/xml/gen.sh rename to docgen/schema-v1/xml/gen.sh diff --git a/docgen/xml/xs3p.xsl b/docgen/schema-v1/xml/xs3p.xsl similarity index 100% rename from docgen/xml/xs3p.xsl rename to docgen/schema-v1/xml/xs3p.xsl From c5fc0d55dd588b9041230d14a579a3114cc92f9f Mon Sep 17 00:00:00 2001 From: Jan Kowalleck Date: Mon, 10 Aug 2026 19:59:30 +0200 Subject: [PATCH 2/4] chore: split docs CDX1.x Signed-off-by: Jan Kowalleck --- docgen/schema-v1/json/gen.sh | 3 +-- docgen/schema-v1/proto/gen.sh | 2 +- docgen/schema-v1/xml/gen.sh | 2 +- 3 files changed, 3 insertions(+), 4 deletions(-) diff --git a/docgen/schema-v1/json/gen.sh b/docgen/schema-v1/json/gen.sh index 8357f2ef5..e2dab831c 100755 --- a/docgen/schema-v1/json/gen.sh +++ b/docgen/schema-v1/json/gen.sh @@ -2,7 +2,6 @@ set -eu declare -a CDX_VERSIONS=( - '2.0' '1.7' '1.6' '1.5' @@ -22,7 +21,7 @@ Supported values for CDX_VERSION: ${CDX_VERSIONS[*]} THIS_PATH="$(realpath "$(dirname "$0")")" -SCHEMA_PATH="$(realpath "$THIS_PATH/../../schema")" +SCHEMA_PATH="$(realpath "$THIS_PATH/../../../schema")" DOCS_PATH="$THIS_PATH/docs" TEMPLATES_PATH="$THIS_PATH/templates" diff --git a/docgen/schema-v1/proto/gen.sh b/docgen/schema-v1/proto/gen.sh index 93d8ec6f4..47b02c979 100755 --- a/docgen/schema-v1/proto/gen.sh +++ b/docgen/schema-v1/proto/gen.sh @@ -20,7 +20,7 @@ Supported values for CDX_VERSION: ${CDX_VERSIONS[*]} THIS_PATH="$(realpath "$(dirname "$0")")" -SCHEMA_PATH="$(realpath "$THIS_PATH/../../schema")" +SCHEMA_PATH="$(realpath "$THIS_PATH/../../../schema")" DOCS_PATH="$THIS_PATH/docs" TEMPLATES_PATH="$THIS_PATH/templates" diff --git a/docgen/schema-v1/xml/gen.sh b/docgen/schema-v1/xml/gen.sh index 3aa498b03..768d6c272 100755 --- a/docgen/schema-v1/xml/gen.sh +++ b/docgen/schema-v1/xml/gen.sh @@ -23,7 +23,7 @@ Supported values for CDX_VERSION: ${CDX_VERSIONS[*]} THIS_PATH="$(realpath "$(dirname "$0")")" -SCHEMA_PATH="$(realpath "$THIS_PATH/../../schema")" +SCHEMA_PATH="$(realpath "$THIS_PATH/../../../schema")" DOCS_PATH="$THIS_PATH/docs" # Centralized header injection From 998df95fcdbaa93633342c64affb407f52e890bd Mon Sep 17 00:00:00 2001 From: Jan Kowalleck Date: Mon, 10 Aug 2026 20:01:38 +0200 Subject: [PATCH 3/4] chore: split docs CDX1.x Signed-off-by: Jan Kowalleck --- docgen/schema-v2/.gitkeep | 0 1 file changed, 0 insertions(+), 0 deletions(-) create mode 100644 docgen/schema-v2/.gitkeep diff --git a/docgen/schema-v2/.gitkeep b/docgen/schema-v2/.gitkeep new file mode 100644 index 000000000..e69de29bb From 1beae2bfd6c0baeb8a978f7a2e8c9041aded7619 Mon Sep 17 00:00:00 2001 From: Jan Kowalleck Date: Mon, 10 Aug 2026 20:04:31 +0200 Subject: [PATCH 4/4] chore: split docs CDX1.x Signed-off-by: Jan Kowalleck --- .github/workflows/build_1.x_docs.yml | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/.github/workflows/build_1.x_docs.yml b/.github/workflows/build_1.x_docs.yml index 2e7781be1..44b03f308 100644 --- a/.github/workflows/build_1.x_docs.yml +++ b/.github/workflows/build_1.x_docs.yml @@ -38,7 +38,7 @@ jobs: uses: actions/upload-artifact@043fb46d1a93c77aae656e7c1c64a875d1fc6a0a # v7.0.1 with: name: XML-Schema-documentation - path: docgen/xml/docs + path: docgen/schema-v1/xml/docs if-no-files-found: error docs_json: runs-on: ubuntu-latest @@ -64,7 +64,7 @@ jobs: uses: actions/upload-artifact@043fb46d1a93c77aae656e7c1c64a875d1fc6a0a # v7.0.1 with: name: JSON-Schema-documentation - path: docgen/json/docs + path: docgen/schema-v1/json/docs if-no-files-found: error docs_proto: runs-on: ubuntu-latest @@ -84,5 +84,5 @@ jobs: uses: actions/upload-artifact@043fb46d1a93c77aae656e7c1c64a875d1fc6a0a # v7.0.1 with: name: PROTO-Schema-documentation - path: docgen/proto/docs + path: docgen/schema-v1/proto/docs if-no-files-found: error