Skip to content
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.

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

chore: depedabot for all used ecosystems #424

Merged
merged 9 commits into from
Apr 10, 2024
Merged
Show file tree
Hide file tree
Changes from 6 commits
Commits
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
40 changes: 40 additions & 0 deletions .github/dependabot.yml
Original file line number Diff line number Diff line change
Expand Up @@ -21,3 +21,43 @@ updates:
prefix: 'chore' ## prefix maximum string length of 15
include: 'scope'
open-pull-requests-limit: 999
- package-ecosystem: 'maven'
directory: '/tools'
schedule:
interval: 'weekly'
day: 'saturday'
labels: [ 'dependencies' ]
commit-message:
prefix: 'chore' ## prefix maximum string length of 15
include: 'scope'
open-pull-requests-limit: 999
- package-ecosystem: 'composer'
directory: '/tools/src/test/php'
schedule:
interval: 'weekly'
day: 'saturday'
labels: [ 'dependencies' ]
commit-message:
prefix: 'chore' ## prefix maximum string length of 15
include: 'scope'
open-pull-requests-limit: 999
- package-ecosystem: 'npm'
directory: '/tools/src/test/js'
schedule:
interval: 'weekly'
day: 'saturday'
labels: [ 'dependencies' ]
commit-message:
prefix: 'chore' ## prefix maximum string length of 15
include: 'scope'
open-pull-requests-limit: 999
- package-ecosystem: 'pip'
directory: '/docgen/json'
schedule:
interval: 'weekly'
day: 'saturday'
labels: [ 'dependencies' ]
commit-message:
prefix: 'chore' ## prefix maximum string length of 15
include: 'scope'
open-pull-requests-limit: 999
11 changes: 6 additions & 5 deletions .github/workflows/build_docs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -19,12 +19,13 @@ jobs:
- name: Checkout
# see https://github.com/actions/checkout
uses: actions/checkout@v4
- name: Setup Python Environment
# see https://github.com/actions/setup-python
uses: actions/setup-python@v5
- name: Set up JDK
# see https://github.com/actions/setup-java
uses: actions/setup-java@v4
with:
python-version: ${{ env.PYTHON_VERSION_DEFAULT }}
architecture: 'x64'
java-version: '21'
distribution: 'zulu'
java-package: jdk
- name: Generate Schema documentation
run: ./gen.sh
- name: Archive Schema documentation
Expand Down
53 changes: 36 additions & 17 deletions docgen/json/gen.sh
Original file line number Diff line number Diff line change
@@ -1,31 +1,50 @@
#!/bin/bash
rm -f -R docs
mkdir -p docs/{1.2,1.3,1.4,1.5,1.6}
set -eu

THIS_DIR="$(dirname "$0")"
SCHEMA_DIR="$(realpath "$THIS_DIR/../../schema")"
DOCS_DIR="$THIS_DIR/docs"
TEMPLATES_DIR="$THIS_DIR/templates"

rm -f -R "$DOCS_DIR"
mkdir -p "$DOCS_DIR/"{1.2,1.3,1.4,1.5,1.6}

# 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)" ]; then
pip3 install json-schema-for-humans==0.47
if ! [ -x "$(command -v generate-schema-doc)" ]
then
pip3 install -r "$THIS_DIR/requirements.txt"
fi

generate () {
version=$1
title='CycloneDX v'$version' JSON Reference'
echo Generating $title
STRICT_SCHEMA_FILE='../../schema/bom-'$version'-strict.schema.json'
version="$1"
title="CycloneDX v${version} JSON Reference"
echo "Generating: $title"

SCHEMA_FILE="$SCHEMA_DIR/bom-${version}.schema.json"
STRICT_SCHEMA_FILE="$SCHEMA_DIR/bom-${version}-strict.schema.json"
if [ -f "$STRICT_SCHEMA_FILE" ]; then
SCHEMA_FILE='../../schema/bom-'$version'-strict.schema.json'
else
SCHEMA_FILE='../../schema/bom-'$version'.schema.json'
SCHEMA_FILE="$STRICT_SCHEMA_FILE"
fi
echo $SCHEMA_FILE
generate-schema-doc --config no_link_to_reused_ref --config no_show_breadcrumbs --config no_collapse_long_descriptions --deprecated-from-description --config title="$title" --config custom_template_path=$(pwd)'/templates/cyclonedx/base.html' --minify $SCHEMA_FILE 'docs/'$version'/index.html'
sed -i -e "s/\${quotedTitle}/\"$title\"/g" 'docs/'$version'/index.html'
sed -i -e "s/\${title}/$title/g" 'docs/'$version'/index.html'
sed -i -e "s/\${version}/$version/g" 'docs/'$version'/index.html'
echo "$SCHEMA_FILE"

generate-schema-doc \
--config no_link_to_reused_ref \
--config no_show_breadcrumbs \
--config no_collapse_long_descriptions \
--deprecated-from-description \
--config title="$title" \
--config custom_template_path="$TEMPLATES_DIR/cyclonedx/base.html" \
--minify \
"$SCHEMA_FILE" \
"$DOCS_DIR/$version/index.html"

sed -i -e "s/\${quotedTitle}/\"$title\"/g" "$DOCS_DIR/$version/index.html"
sed -i -e "s/\${title}/$title/g" "$DOCS_DIR/$version/index.html"
sed -i -e "s/\${version}/$version/g" "$DOCS_DIR/$version/index.html"
}

generate 1.2
generate 1.3
generate 1.4
generate 1.5
generate 1.6
generate 1.6
1 change: 1 addition & 0 deletions docgen/json/requirements.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
json-schema-for-humans==0.47
29 changes: 22 additions & 7 deletions docgen/xml/gen.sh
Original file line number Diff line number Diff line change
@@ -1,14 +1,29 @@
#!/bin/bash
set -eu

THIS_DIR="$(dirname "$0")"
SCHEMA_DIR="$(realpath "$THIS_DIR/../../schema")"
DOCS_DIR="$THIS_DIR/docs"

SAXON_JAR='Saxon-HE-9.9.1-8.jar'

rm -f -R docs
if [ ! -f "Saxon-HE-9.9.1-8.jar" ]; then
curl -O https://repo1.maven.org/maven2/net/sf/saxon/Saxon-HE/9.9.1-8/Saxon-HE-9.9.1-8.jar
if [ ! -f "$THIS_DIR/$SAXON_JAR" ]; then
curl --output-dir "$THIS_DIR" -O \
"https://repo1.maven.org/maven2/net/sf/saxon/Saxon-HE/9.9.1-8/$SAXON_JAR"
fi

generate () {
version=$1
title='CycloneDX v'$version' XML Reference'
echo Generating $title
java -jar Saxon-HE-9.9.1-8.jar -s:'../../schema/bom-'$version'.xsd' -xsl:xs3p.xsl -o:'./docs/'$version'/index.html' cycloneDxVersion="$version" title="$title"
version="$1"
title="CycloneDX v$version XML Reference"
echo "Generating: $title"

java -jar "$THIS_DIR/$SAXON_JAR" \
-s:"$SCHEMA_DIR/bom-${version}.xsd" \
-xsl:"$THIS_DIR/xs3p.xsl" \
-o:"$DOCS_DIR/$version/index.html" \
cycloneDxVersion="$version" \
title="$title"
}

generate 1.0
Expand All @@ -17,4 +32,4 @@ generate 1.2
generate 1.3
generate 1.4
generate 1.5
generate 1.6
generate 1.6