diff --git a/.github/workflows/build_docs.yml b/.github/workflows/build_1.x_docs.yml similarity index 89% rename from .github/workflows/build_docs.yml rename to .github/workflows/build_1.x_docs.yml index 3c4377c86..44b03f308 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 @@ -38,13 +38,13 @@ 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 defaults: run: - working-directory: docgen/json + working-directory: docgen/schema-v1/json steps: - name: Checkout # see https://github.com/actions/checkout @@ -64,13 +64,13 @@ 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 defaults: run: - working-directory: docgen/proto + working-directory: docgen/schema-v1/proto steps: - name: Checkout # see https://github.com/actions/checkout @@ -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 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 97% rename from docgen/json/gen.sh rename to docgen/schema-v1/json/gen.sh index 8357f2ef5..e2dab831c 100755 --- a/docgen/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/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 97% rename from docgen/proto/gen.sh rename to docgen/schema-v1/proto/gen.sh index 93d8ec6f4..47b02c979 100755 --- a/docgen/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/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 97% rename from docgen/xml/gen.sh rename to docgen/schema-v1/xml/gen.sh index 3aa498b03..768d6c272 100755 --- a/docgen/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 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 diff --git a/docgen/schema-v2/.gitkeep b/docgen/schema-v2/.gitkeep new file mode 100644 index 000000000..e69de29bb