[wip] more comparisons

Author: avivkeller

.github/workflows/compare-builds.yml

@@ -0,0 +1,163 @@
+name: Generate Docs
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+    branches: [main]
+  workflow_dispatch:
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: true
+
+permissions:
+  contents: read
+
+jobs:
+  prepare:
+    runs-on: ubuntu-latest
+    outputs:
+      sha: ${{ steps.push.outputs.sha || steps.pr.outputs.sha }}
+      base-run: ${{ steps.main.outputs.run_id }}
+    steps:
+      - name: Harden Runner
+        uses: step-security/harden-runner@20cf305ff2072d973412fa9b1e3a4f227bda3c76 # v2.14.0
+        with:
+          egress-policy: audit
+
+      # If we are running from the main branch (a non-pull_request event), we
+      # want the latest SHA from nodejs/node
+      - id: push
+        if: ${{ github.event_name != 'pull_request' }}
+        run: |
+          SHA=$(git ls-remote https://github.com/nodejs/node. git HEAD | awk '{print $1}')
+          echo "$SHA" > commit
+          echo "sha=$SHA" >> "$GITHUB_OUTPUT"
+
+      - name: Upload metadata artifact
+        if: ${{ github.event_name != 'pull_request' }}
+        uses: actions/upload-artifact@330a01c490aca151604b8cf639adc76d48f6c5d4 # v5.0.0
+        with:
+          name: commit
+          path: commit
+
+      # If we are running from a PR (a pull_request event), we
+      # want the SHA used by the most recent `push` run
+      - name: Get latest `main` run
+        if: ${{ github.event_name == 'pull_request' }}
+        id: main
+        env:
+          WORKFLOW_ID: ${{ github.workflow_ref }}
+          BASE_SHA: ${{ github.event.pull_request.base.sha }}
+          GH_TOKEN: ${{ github.token }}
+        run: |
+          ID=$(gh run list -c $GITHUB_SHA -w $WORKFLOW_ID -L 1 --json databaseId --jq ".[]. databaseId")
+          echo "run_id=$ID" >> $GITHUB_OUTPUT
+
+      - name: Download metadata artifact
+        if: ${{ github.event_name == 'pull_request' }}
+        uses: actions/download-artifact@018cc2cf5baa6db3ef3c5f8a56943fffe632ef53 # v6.0.0
+        with:
+          name: commit
+          run-id: ${{ steps.main.outputs.run_id }}
+          github-token: ${{ secrets.GITHUB_TOKEN }}
+
+      - id: pr
+        if: ${{ github.event_name == 'pull_request' }}
+        run: |
+          SHA=$(cat commit)
+          echo "sha=$SHA" >> "$GITHUB_OUTPUT"
+
+  generate:
+    runs-on: ubuntu-latest
+    needs: prepare
+    strategy:
+      matrix:
+        include:
+          - target: man-page
+            input: './node/doc/api/cli.md'
+          - target: addon-verify
+            input: './node/doc/api/addons.md'
+          - target: api-links
+            input: './node/lib/*.js'
+          - target: orama-db
+            input: './node/doc/api/*.md'
+          - target: json-simple
+            input: './node/doc/api/*.md'
+          - target: legacy-json
+            input: './node/doc/api/*.md'
+            compare: true
+          - target: legacy-html
+            input: './node/doc/api/*.md'
+          - target: web
+            input: './node/doc/api/*.md'
+            compare: true
+          - target: llms-txt
+            input: './node/doc/api/*.md'
+      fail-fast: false
+
+    steps:
+      - name: Harden Runner
+        uses: step-security/harden-runner@95d9a5deda9de15063e7595e9719c11c38c90ae2 # v2.13.2
+        with:
+          egress-policy: audit
+
+      - name: Git Checkout
+        uses: actions/checkout@1af3b93b6815bc44a9784bd300feb67ff0d1eeb3 # v6.0.0
+        with:
+          persist-credentials: false
+
+      - name: Git Checkout
+        uses: actions/checkout@1af3b93b6815bc44a9784bd300feb67ff0d1eeb3 # v6.0.0
+        with:
+          persist-credentials: false
+          repository: nodejs/node
+          ref: ${{ needs.prepare.outputs.sha }}
+          sparse-checkout: |
+            doc/api
+            lib
+            .
+          path: node
+
+      - name: Setup Node.js
+        uses: actions/setup-node@2028fbc5c25fe9cf00d9f06a71cc4710d4507903 # v6.0.0
+        with:
+          node-version-file: '.nvmrc'
+          cache: 'npm'
+
+      - name: Install dependencies
+        run: npm ci
+
+      - name: Create output directory
+        run: mkdir -p out/${{ matrix.target }}
+
+      - name: Generate ${{ matrix.target }}
+        run: |
+          node bin/cli.mjs generate \
+            -t ${{ matrix.target }} \
+            -i "${{ matrix.input }}" \
+            -o out \
+            -c ./node/CHANGELOG.md \
+            --index ./node/doc/api/index.md \
+            --log-level debug
+
+      - name: Download base branch artifact
+        if: ${{ matrix.compare && needs.prepare.outputs.base-run }}
+        uses: actions/download-artifact@018cc2cf5baa6db3ef3c5f8a56943fffe632ef53 # v6.0.0
+        with:
+          name: ${{ matrix.target }}
+          path: base
+          run-id: ${{ needs.prepare.outputs.base-run }}
+          github-token: ${{ secrets.GITHUB_TOKEN }}
+
+      - name: Compare to base branch
+        if: ${{ matrix.compare && needs.prepare.outputs.base-run }}
+        run: |
+          node scripts/compare-builds/${{ matrix.target }}.mjs > out/comparison.txt
+
+      - name: Upload ${{ matrix.target }} artifacts
+        uses: actions/upload-artifact@330a01c490aca151604b8cf639adc76d48f6c5d4 # v5.0.0
+        with:
+          name: ${{ matrix.target }}
+          path: out