[2.0] bundler rewrite

.config/cyclonedx-2.0-bundled.cdxlintrc.json

@@ -0,0 +1,11 @@
+{
+  "$comment": "This ia a cdxlinter config for file `../schema/2.0/cyclonedx-2.0-bundled[.min].schema.json`",
+  "checks": {
+  },
+  "includeChecks": [
+    "schema-draft",
+    "schema-id-pattern",
+    "schema-id-filepath",
+    "schema-comment"
+  ]
+}

.github/workflows/bundle_2.0_schemas.yml

@@ -18,20 +18,24 @@ concurrency:
   cancel-in-progress: true
 
 # https://docs.github.com/en/actions/writing-workflows/choosing-what-your-workflow-does/controlling-permissions-for-github_token
-permissions: {}
+permissions: { }
+
+env:
+  SCHEMA_VERSION: '2.0'
+  SCHEMA_DIR: schema/2.0
+  MODULES_DIR: schema/2.0/modules
+  SOURCE_FILE: schema/2.0/cyclonedx-2.0.schema.json
+  BUNDLED_FILE: schema/2.0/cyclonedx-2.0-bundled.schema.json
+  MINIFIED_FILE: schema/2.0/cyclonedx-2.0-bundled.min.schema.json
+  NODE_VERSION: '24.x'
 
 jobs:
   bundle-schemas:
     name: Bundle Schemas
+    outputs:
+      has_changes: ${{ steps.changes.outputs.has_changes }}
     runs-on: ubuntu-latest
-    timeout-minutes: 30
-    permissions:
-      contents: write  # Required to push changes
-    env:
-      MODULES_DIR: schema/2.0/modules
-      SOURCE_FILE: schema/2.0/cyclonedx-2.0.schema.json
-      BUNDLED_FILE: schema/2.0/cyclonedx-2.0-bundled.schema.json
-      MINIFIED_FILE: schema/2.0/cyclonedx-2.0-bundled.min.schema.json
+    timeout-minutes: 10
     steps:
       - name: Checkout repository
         # see https://github.com/actions/checkout
@@ -42,32 +46,156 @@ jobs:
         # see https://github.com/actions/setup-node
         uses: actions/setup-node@820762786026740c76f36085b0efc47a31fe5020 # v7.0.0
         with:
-          node-version: '24.x'
+          node-version: ${{ env.NODE_VERSION }}
+          package-manager-cache: false
       - name: Install dependencies
         working-directory: tools/src/main/js/bundler
         run: npm ci --no-fund --no-audit
       - name: Bundle schemas
+        run: >
+          node tools/src/main/js/bundler/cli.js
+          "$MODULES_DIR" "$SOURCE_FILE"
+      - name: Detect changes
+        id: changes
         run: |
-          set -eux
-          node tools/src/main/js/bundler/bundle-schemas.js \
-            "$MODULES_DIR" "$SOURCE_FILE"
+          if git diff --quiet; then
+            echo "has_changes=false" >> "$GITHUB_OUTPUT"
+          else
+            echo "has_changes=true" >> "$GITHUB_OUTPUT"
+          fi
+      - name: Upload modified
+        if: ${{ steps.changes.outputs.has_changes == 'true' }}
+        # see https://github.com/actions/upload-artifact
+        uses: actions/upload-artifact@043fb46d1a93c77aae656e7c1c64a875d1fc6a0a # v7.0.1
+        with:
+          name: modified
+          if-no-files-found: error
+          path: |
+            ${{ env.BUNDLED_FILE }}
+            ${{ env.MINIFIED_FILE }}
+          retention-days: 1
+  test-schemas:
+    name: Test Bundled Schemas
+    needs:
+      - bundle-schemas
+    if: ${{ needs.bundle-schemas.outputs.has_changes == 'true' }}
+    runs-on: ubuntu-latest
+    timeout-minutes: 10
+    defaults:
+      run:
+        working-directory: tools/src/test/js/schema-v2
+    steps:
+      - name: Checkout repository
+        # see https://github.com/actions/checkout
+        uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
+        with:
+          persist-credentials: false
+      - name: Download modified
+        # see https://github.com/actions/download-artifact
+        uses: actions/download-artifact@3e5f45b2cfb9172054b4087a40e8e0b5a5461e7c # v8.0.1
+        with:
+          name: modified
+          path: ${{ env.SCHEMA_DIR }}
+      - name: Setup Node.js
+        # see https://github.com/actions/setup-node
+        uses: actions/setup-node@820762786026740c76f36085b0efc47a31fe5020 # v7.0.0
+        with:
+          node-version: ${{ env.NODE_VERSION }}
+          package-manager-cache: false
+      - name: Install Dependencies
+        run: npm install --no-fund --no-audit
+      - name: Run test
+        env:
+          TEST_BUNDLED_ONLY: true
+        run: npm run "test:v$SCHEMA_VERSION"
+  lint-schemas:
+    name: Lint Bundled Schemas
+    needs:
+      - bundle-schemas
+    if: ${{ needs.bundle-schemas.outputs.has_changes == 'true' }}
+    runs-on: ubuntu-latest
+    timeout-minutes: 10
+    env:
+      REPORT_FILE: tools/src/main/js/linter/reports/bundled.json
+    steps:
+      - name: Checkout repository
+        # see https://github.com/actions/checkout
+        uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
+        with:
+          persist-credentials: false
+      - name: Download modified
+        # see https://github.com/actions/download-artifact
+        uses: actions/download-artifact@3e5f45b2cfb9172054b4087a40e8e0b5a5461e7c # v8.0.1
+        with:
+          name: modified
+          path: ${{ env.SCHEMA_DIR }}
+      - name: Setup Node.js
+        # see https://github.com/actions/setup-node
+        uses: actions/setup-node@820762786026740c76f36085b0efc47a31fe5020 # v7.0.0
+        with:
+          node-version: ${{ env.NODE_VERSION }}
+          package-manager-cache: false
+      - name: Install Dependencies
+        run: npm ci --no-fund --no-audit
+        working-directory: tools/src/main/js/linter
+      - name: Lint schemas
+        run: |
+          set -eu
+          mkdir -p "$(dirname "$REPORT_FILE")"
+          node tools/src/main/js/linter/cli.js \
+          --config ".config/cyclonedx-${SCHEMA_VERSION}-bundled.cdxlintrc.json" \
+          --format json \
+          "$BUNDLED_FILE" "$MINIFIED_FILE" \
+          > "$REPORT_FILE"
+      - name: Make report relative
+        if: ${{ !cancelled() }}
+        run: sed -i "s|${GITHUB_WORKSPACE}/||g" "$REPORT_FILE"
+      - name: Print report
+        if: ${{ !cancelled() }}
+        run: cat "$REPORT_FILE"
+      - name: Artifact report
+        if: ${{ !cancelled() }}
+        # https://github.com/actions/upload-artifact
+        uses: actions/upload-artifact@043fb46d1a93c77aae656e7c1c64a875d1fc6a0a # v7.0.1
+        with:
+          name: report_${{ env.SCHEMA_VERSION }}-bundled
+          path: ${{ env.REPORT_FILE }}
+          if-no-files-found: error
+  push-schemas:
+    name: Push Bundled Schemas
+    needs:
+      - bundle-schemas
+      - test-schemas
+      - lint-schemas
+    if: ${{ needs.bundle-schemas.outputs.has_changes == 'true' }}
+    runs-on: ubuntu-latest
+    timeout-minutes: 10
+    permissions:
+      contents: write  # Required to push changes
+    steps:
+      - name: Checkout repository
+        # see https://github.com/actions/checkout
+        uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
+        with:
+          persist-credentials: false
+      - name: Download modified
+        # see https://github.com/actions/download-artifact
+        uses: actions/download-artifact@3e5f45b2cfb9172054b4087a40e8e0b5a5461e7c # v8.0.1
+        with:
+          name: modified
+          path: ${{ env.SCHEMA_DIR }}
       - name: Check for changes and commit
         env:
           GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
         run: |
           set -eu
-
           # Add both files (works for both new and modified files)
           git add "$BUNDLED_FILE" "$MINIFIED_FILE"
-
-          # Check if there are staged changes
-          if git diff --staged --quiet
-          then
-            echo "No changes to bundled schemas"
-          else
-            echo "Committing bundled schema changes"
-            git config --local user.email "github-actions[bot]@users.noreply.github.com"
-            git config --local user.name "github-actions[bot]"
-            git commit -m "chore: update bundled schemas [skip ci]"
-            git push "https://x-access-token:${GH_TOKEN}@github.com/${GITHUB_REPOSITORY}.git"
-          fi
+          echo "Committing bundled schema changes"
+          git config --local user.email "github-actions[bot]@users.noreply.github.com"
+          git config --local user.name "github-actions[bot]"
+          git commit -sm "chore: update bundled schemas"
+          echo "Pushing to ${GITHUB_REF_NAME}"
+          git push \
+            "https://x-access-token:${GH_TOKEN}@github.com/${GITHUB_REPOSITORY}.git" \
+            "HEAD:refs/heads/${GITHUB_REF_NAME}"

.github/workflows/bundler-test.yml

@@ -7,11 +7,11 @@ on:
       - 'main'
       - '2.0-dev'
     paths:
-      - '.github/workflows/test_bundler.yml' # self
+      - '.github/workflows/bundler-test.yml' # self
       - 'tools/src/main/js/bundler/**'
   pull_request:
     paths:
-      - '.github/workflows/test_bundler.yml' # self
+      - '.github/workflows/bundler-test.yml' # self
       - 'tools/src/main/js/bundler/**'
   workflow_dispatch:  # Allows manual trigger
 
@@ -43,7 +43,10 @@ jobs:
         uses: actions/setup-node@820762786026740c76f36085b0efc47a31fe5020 # v7.0.0
         with:
           node-version: '24.x'
+          package-manager-cache: false
       - name: Install dependencies
         run: npm ci --no-fund --no-audit
       - name: Run tests
+        env:
+          UPDATE_SNAPSHOTS: 0
         run: npm test

.github/workflows/lint_2.x_schemas.yml

@@ -123,14 +123,6 @@ jobs:
           if-no-files-found: error
           retention-days: 1
   lint-bundled:
-    if: >-
-      ${{ github.ref == 'refs/heads/master'
-      || github.ref == 'refs/heads/main'
-      || github.ref == 'refs/heads/2.0-dev'
-      || (  github.event_name == 'pull_request'
-         && github.base_ref == 'master'
-         )
-      }}
     needs:
       - discover-schema
     timeout-minutes: 10
@@ -175,10 +167,7 @@ jobs:
           mkdir -p "$(dirname "$REPORT_FILE")"
           # only run checks not carried over from source files
           node tools/src/main/js/linter/cli.js \
-            --include schema-draft \
-            --include schema-id-pattern \
-            --include schema-id-filepath \
-            --include schema-comment \
+            --config ".config/cyclonedx-${SCHEMA_VERSION}-bundled.cdxlintrc.json" \
             --format json \
             "${schemas[@]}" \
             > "$REPORT_FILE"

.github/workflows/test_2.x_js.yml

@@ -7,6 +7,11 @@ on:
     branches: ['master', 'main']
   pull_request:
   workflow_dispatch:
+    inputs:
+      test_bundled:
+        description: 'Also test the committed bundled schema files'
+        type: boolean
+        default: false
 
 concurrency:
   group: ${{ github.workflow }}-${{ github.ref }}
@@ -26,9 +31,39 @@ env:
 jobs:
   discover-schema:
     uses: $/.github/workflows/discover_2.x_schema.yml
+  detect-bundled-changes:
+    # Bundled schemas are generated and tested by `bundle_2.0_schemas.yml`.
+    # Here they are only re-tested when a PR actually touches them.
+    name: Detect bundled schema changes
+    if: ${{ github.event_name == 'pull_request' }}
+    timeout-minutes: 5
+    runs-on: ubuntu-latest
+    outputs:
+      changed: ${{ steps.detect.outputs.changed }}
+    steps:
+      - name: Checkout
+        # see https://github.com/actions/checkout
+        uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1  # v7.0.1
+        with:
+          persist-credentials: false
+          # PR checkout is the merge commit; depth 2 brings in both parents,
+          # so `HEAD^1` is the base branch tip.
+          fetch-depth: 2
+      - name: Detect changes
+        id: detect
+        working-directory: ${{ github.workspace }}
+        run: |
+          if git diff --quiet HEAD^1 HEAD -- 'schema/*/*-bundled*.schema.json'; then
+            echo 'changed=false' >> "$GITHUB_OUTPUT"
+          else
+            echo 'changed=true' >> "$GITHUB_OUTPUT"
+          fi
   test_js:
     needs:
       - discover-schema
+      - detect-bundled-changes
+    # `detect-bundled-changes` is skipped for push/workflow_dispatch - still run the tests then
+    if: ${{ !cancelled() && !failure() }}
     timeout-minutes: 30
     runs-on: ubuntu-latest
     strategy:
@@ -52,13 +87,14 @@ jobs:
         run: npm install --no-fund --no-audit
       - name: Run test
         env:
-          VALIDATE_BUNDLED: >-
-            ${{ github.ref == 'refs/heads/master'
-             || github.ref == 'refs/heads/main'
-             || github.ref == 'refs/heads/2.0-dev'
-             || (  github.event_name == 'pull_request'
-                && github.base_ref == 'master'
-                )
-            }}
           SCHEMA_VERSION: ${{ matrix.schema_version }}
+          # dispatch: honor the input
+          # pull_request: only if bundled files changed
+          # push to master/main: always (rare, and that is where published bundles live)
+          TEST_BUNDLED: >-
+            ${{ inputs.test_bundled == true
+             || needs.detect-bundled-changes.outputs.changed == 'true'
+             || github.event_name == 'push'
+            }}
+          TEST_BUNDLED_ONLY: false
         run: npm run "test:v$SCHEMA_VERSION"