diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md new file mode 100644 index 00000000..3eeed837 --- /dev/null +++ b/.github/pull_request_template.md @@ -0,0 +1,24 @@ + + + diff --git a/.github/workflows/build_docs.yml b/.github/workflows/build_docs.yml index 2d0b41e9..492a8e9d 100644 --- a/.github/workflows/build_docs.yml +++ b/.github/workflows/build_docs.yml @@ -59,3 +59,21 @@ jobs: name: JSON-Schema-documentation path: docgen/json/docs if-no-files-found: error + docs_proto: + runs-on: ubuntu-latest + defaults: + run: + working-directory: docgen/proto + steps: + - name: Checkout + # see https://github.com/actions/checkout + uses: actions/checkout@v4 + - name: Generate Schema documentation + run: ./gen.sh + - name: Archive Schema documentation + # https://github.com/actions/upload-artifact + uses: actions/upload-artifact@v4 + with: + name: PROTO-Schema-documentation + path: docgen/proto/docs + if-no-files-found: error diff --git a/README.md b/README.md index b12c9a80..ecdaaf95 100644 --- a/README.md +++ b/README.md @@ -47,14 +47,24 @@ free, open source, and proprietary tools and solutions that support the CycloneD The following media types are officially registered with IANA: | Media Type | Format | Assignment | -| ------- | --------- | --------- | -| application/vnd.cyclonedx+xml | XML | [IANA](https://www.iana.org/assignments/media-types/application/vnd.cyclonedx+xml) | -| application/vnd.cyclonedx+json | JSON | [IANA](https://www.iana.org/assignments/media-types/application/vnd.cyclonedx+json) | +|------------|--------|------------| +| `application/vnd.cyclonedx+xml` | XML | [IANA](https://www.iana.org/assignments/media-types/application/vnd.cyclonedx+xml) | +| `application/vnd.cyclonedx+json` | JSON | [IANA](https://www.iana.org/assignments/media-types/application/vnd.cyclonedx+json) | +| `application/x.vnd.cyclonedx+protobuf` | Protocol Buffer | | Specific versions of CycloneDX can be specified by using the version parameter. For example: `application/vnd.cyclonedx+xml; version=1.6`. -The officially supported media type for Protocol Buffer format is `application/x.vnd.cyclonedx+protobuf`. +## Recognized file patterns + +The following file names are conventionally used for storing CycloneDX BOM files: +* `bom.json` for JSON encoded CycloneDX BOM files. +* `bom.xml` for XML encoded CycloneDX BOM files. + +Alternatively, files that match the glob pattern below are also recognized: +* `*.cdx.json` for JSON encoded CycloneDX BOM files. +* `*.cdx.xml` for XML encoded CycloneDX BOM files. + ## Release History diff --git a/docgen/json/gen.sh b/docgen/json/gen.sh index 19149d5b..2bc858d7 100755 --- a/docgen/json/gen.sh +++ b/docgen/json/gen.sh @@ -7,7 +7,7 @@ DOCS_PATH="$THIS_PATH/docs" TEMPLATES_PATH="$THIS_PATH/templates" rm -f -R "$DOCS_PATH" -mkdir -p "$DOCS_PATH/"{1.2,1.3,1.4,1.5,1.6} +mkdir -p "$DOCS_PATH/"{1.2,1.3,1.4,1.5,1.6,1.7} # Check to see if generate-schema-doc is executable and is in the path. If not, install JSON Schema for Humans. if ! [ -x "$(command -v generate-schema-doc)" ] @@ -45,8 +45,9 @@ generate () { sed -i -e "s/\${version}/$version/g" "$DOCS_PATH/$version/index.html" } -generate 1.2 -generate 1.3 -generate 1.4 -generate 1.5 +generate 1.7 generate 1.6 +generate 1.5 +generate 1.4 +generate 1.3 +generate 1.2 diff --git a/docgen/json/requirements.txt b/docgen/json/requirements.txt index a7bd8f03..d5e43567 100644 --- a/docgen/json/requirements.txt +++ b/docgen/json/requirements.txt @@ -1 +1 @@ -json-schema-for-humans==0.47 +json-schema-for-humans==1.3.4 diff --git a/docgen/json/templates/cyclonedx/base.html b/docgen/json/templates/cyclonedx/base.html index 6f89d18b..1f7e3005 100644 --- a/docgen/json/templates/cyclonedx/base.html +++ b/docgen/json/templates/cyclonedx/base.html @@ -40,12 +40,14 @@ v${version} (JSON)