feat: use native sbom tools instead of custom solutions for listing dependencies

.github/workflows/reusable-build-docs-application.yml

@@ -38,16 +38,11 @@ jobs:
         with:
           fetch-depth: 0
 
-      - name: Setup .NET 9 (for lib and api)
+      - name: Setup .NET 9 (for CycloneDX, lib and api)
         uses: actions/setup-dotnet@v4
         with:
           dotnet-version: 9.0.x
 
-      - name: Setup .NET 7 (for dotnet-project-licenses)
-        uses: actions/setup-dotnet@v4
-        with:
-          dotnet-version: 7.0.x
-
       - name: Setup .NET 6 (for dfmg)
         uses: actions/setup-dotnet@v4
         with:
@@ -70,8 +65,8 @@ jobs:
       - name: Install dfmg
         run: dotnet tool install -g DocFxMarkdownGen
 
-      - name: Install dotnet-project-licenses
-        run: dotnet tool install -g dotnet-project-licenses
+      - name: Install CycloneDX
+        run: dotnet tool install --global CycloneDX
 
       - name: Generate .NET API reference
         run: |
@@ -155,61 +150,31 @@ jobs:
       - name: Install dependencies
         run: cd docs; npm ci
 
-      - name: Install dependencies in editor (for license-report)
+      - name: Install dependencies in editor (for sbom generation)
         run: cd src/FacturXDotNet.WebEditor; npm ci
 
-      - name: Install license-report
-        run: npm i -g license-report
+      - name: Generate Editor SBOM
+        run: cd src/FacturXDotNet.WebEditor; npm sbom --sbom-format cyclonedx > ../../docs/src/public/editor.bom.json
 
-      - name: Generate licenses
-        run: |
-          license-report --config docs/license-report-config.json --package src/FacturXDotNet.WebEditor/package.json > docs/src/assets/editor-licenses.json
-
-          echo
-          echo docs/src/assets/editor-licenses.json
-          cat docs/src/assets/editor-licenses.json
-          echo
-          echo
-
-          license-report --config docs/license-report-config.json --package docs/package.json > docs/src/assets/docs-licenses.json
-
-          echo
-          echo docs/src/assets/docs-licenses.json
-          cat docs/src/assets/docs-licenses.json
-          echo
-          echo
-
-          dotnet-project-licenses -i src/FacturXDotNet/FacturXDotNet.csproj --json --output-directory docs/src/assets --outfile library-licenses.json
-
-          echo
-          echo docs/src/assets/library-licenses.json
-          cat docs/src/assets/library-licenses.json
-          echo
-          echo
-
-          dotnet-project-licenses -i src/FacturXDotNet.API/FacturXDotNet.API.csproj --json --output-directory docs/src/assets --outfile api-licenses.json
-
-          echo
-          echo docs/src/assets/api-licenses.json
-          cat docs/src/assets/api-licenses.json
-          echo
-          echo
-
-          dotnet-project-licenses -i src/FacturXDotNet.CLI/FacturXDotNet.CLI.csproj --json --output-directory docs/src/assets --outfile cli-licenses.json
-
-          echo
-          echo docs/src/assets/cli-licenses.json
-          cat docs/src/assets/cli-licenses.json
-          echo
-          echo
+      - name: Generate Docs SBOM
+        run: cd docs; npm sbom --sbom-format cyclonedx > src/public/docs.bom.json
+
+      - name: Generate API SBOM
+        run: cd src/FacturXDotNet.API; dotnet-CycloneDX FacturXDotNet.API.csproj -o ../../docs/src/public --json -fn api.bom.json
+
+      - name: Generate CLI SBOM
+        run: cd src/FacturXDotNet.CLI; dotnet-CycloneDX FacturXDotNet.CLI.csproj -o ../../docs/src/public --json -fn cli.bom.json
+
+      - name: Generate Library SBOM
+        run: cd src/FacturXDotNet; dotnet-CycloneDX FacturXDotNet.csproj -o ../../docs/src/public --json -fn library.bom.json
 
       - name: Write env.json
         run: |
           echo '{'                                            > docs/src/env.json
           echo '  "buildName": "${{ inputs.build-name }}",'   >> docs/src/env.json
           echo '  "version": "${{ inputs.version }}",'        >> docs/src/env.json
           echo '  "editor": {'                                >> docs/src/env.json
-          echo '    "url": "${{ inputs.editor-url }}"'         >> docs/src/env.json
+          echo '    "url": "${{ inputs.editor-url }}"'        >> docs/src/env.json
           echo '  },'                                         >> docs/src/env.json
           echo '  "api": {'                                   >> docs/src/env.json
           echo '    "url": "${{ inputs.api-url }}"'           >> docs/src/env.json
@@ -218,6 +183,9 @@ jobs:
 
           cat docs/src/env.json
 
+      - name: Set version in package json
+        run: cd docs; npm version ${{ inputs.version }}
+
       - name: Build
         run: cd docs; npm run build -- --base /docs/ --outDir dist/
 

.github/workflows/reusable-build-publish-api-docker-image.yml

@@ -48,16 +48,16 @@ jobs:
         with:
           fetch-depth: 0
 
-      - name: Setup .NET 6 (for dotnet-project-licenses)
+      - name: Setup .NET 9 (for CycloneDX)
         uses: actions/setup-dotnet@v4
         with:
-          dotnet-version: 6.0.x
+          dotnet-version: 9.0.x
 
-      - name: Install dotnet-project-licenses
-        run: dotnet tool install -g dotnet-project-licenses --framework net6.0
+      - name: Install CycloneDX
+        run: dotnet tool install --global CycloneDX
 
       - name: Generate licenses file
-        run: cd src/FacturXDotNet.API; dotnet-project-licenses -i dotnet-project-licenses-input.json --json --output-directory Resources
+        run: cd src/FacturXDotNet.API; dotnet-CycloneDX FacturXDotNet.API.csproj -o Resources --json -fn api.bom.json
 
       - name: Build the Docker image
         run: cd src; docker build . --file FacturXDotNet.API/Dockerfile --tag facturxdotnet-api --label "runnumber=${GITHUB_RUN_ID}" --build-arg VERSION=${{ inputs.version }}
@@ -88,7 +88,7 @@ jobs:
           package-name: facturxdotnet-api
           tag: ${{ inputs.tag }}
           github-token: ${{ secrets.GITHUB_TOKEN }}
-      
+
       - name: Push ${{ inputs.tag }}
         if: inputs.tag != ''
         run: |

.github/workflows/reusable-compute-version.yml

@@ -19,7 +19,7 @@ env:
 
 jobs:
   compute_version:
-    name: Build Docker Image
+    name: Compute version
     runs-on: ubuntu-latest
     outputs:
       version: ${{ steps.compute_version.outputs.version }}

docs/.gitignore

@@ -62,8 +62,8 @@ TODOs.md
 src/api-reference/**
 src/cli/**
 src/assets/facturxdotnet.openapi.json
-src/assets/docs-licenses.json
-src/assets/editor-licenses.json
-src/assets/api-licenses.json
-src/assets/cli-licenses.json
-src/assets/library-licenses.json
+src/public/docs.bom.json
+src/public/editor.bom.json
+src/public/api.bom.json
+src/public/cli.bom.json
+src/public/library.bom.json

docs/.vitepress/config.mts

@@ -25,7 +25,7 @@ let cliItems =
     collapsed: false,
     collapsible: false,
   })[0]?.items ?? [];
-cliItems = cliItems.map((item) => ({
+cliItems = cliItems.map(item => ({
   ...item,
   text: item.text.toLowerCase() === "subcommands" ? "Sub Commands" : item.text,
 }));
@@ -39,7 +39,7 @@ let apiReferenceItems =
     collapsible: true,
   })[0]?.items ?? [];
 apiReferenceItems = apiReferenceItems.filter(
-  (i) => i.items !== undefined && i.items.length > 0,
+  i => i.items !== undefined && i.items.length > 0,
 );
 
 const semVersion = semver.valid(env.version)
@@ -218,7 +218,7 @@ export default defineConfigWithTheme({
     },
   },
 
-  transformPageData: (pageData) => {
+  transformPageData: pageData => {
     const result = { ...pageData };
     result.frontmatter = expandEnvInRecord(pageData.frontmatter);
     return result;

docs/.vitepress/theme/custom.css

@@ -103,3 +103,8 @@ p:has(.sidebar-footer) {
         --vp-sidebar-width: 472px; /* default: 272px */
     }
 }
+
+.dependency-description p {
+    margin-top: 0;
+    margin-bottom: 0;
+}

docs/package.json

@@ -1,16 +1,18 @@
 {
+  "name": "facturxdotnet-docs",
+  "version": "0.0.0",
   "type": "module",
   "scripts": {
     "dev": "vitepress dev --port 40850",
     "build": "vitepress build",
     "preview": "vitepress preview --port 40850"
   },
   "devDependencies": {
-    "license-report": "^6.7.2",
     "vitepress": "^1.6.3",
     "vitepress-plugin-nprogress": "^0.0.4"
   },
   "dependencies": {
+    "markdown-it": "^14.1.0",
     "semver": "^7.7.1",
     "vitepress-openapi": "^0.0.3-alpha.76",
     "vitepress-plugin-auto-sidebar": "^1.3.5",