Skip to content

2.0 dev split docsgen #1017

New issue

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

Sign up for GitHub

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

Already on GitHub? Sign in to your account

Merged
jkowalleck merged 4 commits into from
Aug 10, 2026
Merged

2.0 dev split docsgen #1017

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
68da661
chore: split docs CDX1.x
jkowalleck Aug 10, 2026
c5fc0d5
chore: split docs CDX1.x
jkowalleck Aug 10, 2026
998df95
chore: split docs CDX1.x
jkowalleck Aug 10, 2026
1beae2b
chore: split docs CDX1.x
jkowalleck Aug 10, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 7 additions & 7 deletions .github/workflows/build_docs.yml → .github/workflows/build_1.x_docs.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
name: Build Docs
name: Build CDX-1.x Docs

on:
push:
Expand All @@ -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
Expand All @@ -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
Expand All @@ -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
Expand All @@ -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
0 docgen/json/.gitignore → docgen/schema-v1/json/.gitignore
View file
Open in desktop
File renamed without changes.
3 changes: 1 addition & 2 deletions docgen/json/gen.sh → docgen/schema-v1/json/gen.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,6 @@
set -eu

declare -a CDX_VERSIONS=(
'2.0'
'1.7'
'1.6'
'1.5'
Expand All @@ -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"

Expand Down
0 docgen/json/requirements.txt → docgen/schema-v1/json/requirements.txt
View file
Open in desktop
File renamed without changes.
0 .../json/templates/cyclonedx/badge_type.html → .../json/templates/cyclonedx/badge_type.html
View file
Open in desktop
File renamed without changes.
0 docgen/json/templates/cyclonedx/base.html → ...ema-v1/json/templates/cyclonedx/base.html
View file
Open in desktop
File renamed without changes.
0 ...json/templates/cyclonedx/breadcrumbs.html → ...json/templates/cyclonedx/breadcrumbs.html
View file
Open in desktop
File renamed without changes.
0 docgen/json/templates/cyclonedx/content.html → ...-v1/json/templates/cyclonedx/content.html
View file
Open in desktop
File renamed without changes.
0 ...emplates/cyclonedx/macro_restriction.html → ...emplates/cyclonedx/macro_restriction.html
View file
Open in desktop
File renamed without changes.
0 ...n/json/templates/cyclonedx/schema_doc.css → ...1/json/templates/cyclonedx/schema_doc.css
View file
Open in desktop
File renamed without changes.
0 ...en/json/templates/cyclonedx/schema_doc.js → ...v1/json/templates/cyclonedx/schema_doc.js
View file
Open in desktop
File renamed without changes.
0 ...son/templates/cyclonedx/schema_doc.min.js → ...son/templates/cyclonedx/schema_doc.min.js
View file
Open in desktop
File renamed without changes.
0 ...on/templates/cyclonedx/section_array.html → ...on/templates/cyclonedx/section_array.html
View file
Open in desktop
File renamed without changes.
0 ...lonedx/section_conditional_subschema.html → ...lonedx/section_conditional_subschema.html
View file
Open in desktop
File renamed without changes.
0 ...plates/cyclonedx/section_description.html → ...plates/cyclonedx/section_description.html
View file
Open in desktop
File renamed without changes.
0 ...templates/cyclonedx/section_examples.html → ...templates/cyclonedx/section_examples.html
View file
Open in desktop
File renamed without changes.
0 ...json/templates/cyclonedx/section_not.html → ...json/templates/cyclonedx/section_not.html
View file
Open in desktop
File renamed without changes.
0 ...mplates/cyclonedx/section_properties.html → ...mplates/cyclonedx/section_properties.html
View file
Open in desktop
File renamed without changes.
0 ...ion_undocumented_required_properties.html → ...ion_undocumented_required_properties.html
View file
Open in desktop
File renamed without changes.
0 ...n/templates/cyclonedx/tabbed_section.html → ...n/templates/cyclonedx/tabbed_section.html
View file
Open in desktop
File renamed without changes.
0 docgen/proto/.gitignore → docgen/schema-v1/proto/.gitignore
View file
Open in desktop
File renamed without changes.
2 changes: 1 addition & 1 deletion docgen/proto/gen.sh → docgen/schema-v1/proto/gen.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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"

Expand Down
0 docgen/proto/templates/html.tmpl → docgen/schema-v1/proto/templates/html.tmpl
View file
Open in desktop
File renamed without changes.
0 docgen/static/generate-menu.py → docgen/schema-v1/static/generate-menu.py
View file
Open in desktop
File renamed without changes.
0 docgen/static/header.html → docgen/schema-v1/static/header.html
View file
Open in desktop
File renamed without changes.
0 docgen/static/inject-header.sh → docgen/schema-v1/static/inject-header.sh
View file
Open in desktop
File renamed without changes.
0 docgen/static/releases.json → docgen/schema-v1/static/releases.json
View file
Open in desktop
File renamed without changes.
0 docgen/xml/.gitignore → docgen/schema-v1/xml/.gitignore
View file
Open in desktop
File renamed without changes.
2 changes: 1 addition & 1 deletion docgen/xml/gen.sh → docgen/schema-v1/xml/gen.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
0 docgen/xml/xs3p.xsl → docgen/schema-v1/xml/xs3p.xsl
View file
Open in desktop
File renamed without changes.
Empty file added docgen/schema-v2/.gitkeep
View file
Open in desktop
Empty file.
Loading