Add package output for docs

locallycompact · locallycompact · commit 6e8acf51f903 · 2025-08-28T19:30:31.000+01:00
diff --git a/.github/workflows/ci-nix.yaml b/.github/workflows/ci-nix.yaml
@@ -94,14 +94,6 @@ jobs:
     - name: 📚 Documentation (Haddock)
       run: |
         nix build .#haddocks
-        mkdir -p haddocks
-        cp -aL result/* haddocks/
-
-    - name: 💾 Upload haddock artifact
-      uses: actions/upload-artifact@v4
-      with:
-        name: haddocks
-        path: haddocks
 
   benchmarks:
     name: "Benchmarks"
@@ -185,153 +177,3 @@ jobs:
         issue-number: ${{ github.event.pull_request.number }}
         body-file: comment-body.md
         reactions: rocket
-
-  nix-flake-check:
-    name: "nix flake check"
-    runs-on: ${{ matrix.os }}
-    strategy:
-      matrix:
-        os: [ubuntu-latest, macos-latest]
-    steps:
-    - name: Reclaim the bytes
-      uses: data-intuitive/reclaim-the-bytes@v2
-      with:
-        # NOTE: Remove more when needed, but these take also time
-        # See https://github.com/marketplace/actions/reclaim-the-bytes
-        remove-android-sdk: false
-        remove-docker-images: false
-
-    - name: 📥 Checkout repository
-      uses: actions/checkout@v4
-
-    - name: ❄ Setup Nix/Cachix
-      uses: ./.github/actions/nix-cachix-setup
-      with:
-        authToken: '${{ secrets.CACHIX_CARDANO_SCALING_AUTH_TOKEN }}'
-
-    - name: ❄ Nix Flake Check
-      run: |
-        nix flake check -L
-
-
-  build-specification:
-    name: "Build specification using nix"
-    runs-on: ubuntu-latest
-    steps:
-    - name: 📥 Checkout repository
-      uses: actions/checkout@v4
-
-    - name: ❄ Setup Nix/Cachix
-      uses: ./.github/actions/nix-cachix-setup
-      with:
-        authToken: '${{ secrets.CACHIX_CARDANO_SCALING_AUTH_TOKEN }}'
-
-    - name: ❄ Build specification PDF
-      run: |
-        nix build .#spec && cp result/*.pdf .
-
-    - name: 💾 Upload specification
-      uses: actions/upload-artifact@v4
-      with:
-        name: hydra-spec
-        path: |
-          ./*.pdf
-
-
-  documentation:
-    name: Documentation
-    needs: [haddock,benchmarks,build-test,build-specification]
-    runs-on: ubuntu-latest
-    steps:
-    - name: 📥 Checkout repository
-      uses: actions/checkout@v4
-      with:
-        # For the cardanonical json schemas
-        submodules: true
-        # Ensure we have all history with all commits
-        fetch-depth: 0
-
-    - name: ❄ Setup Nix/Cachix
-      uses: ./.github/actions/nix-cachix-setup
-      with:
-        authToken: '${{ secrets.CACHIX_CARDANO_SCALING_AUTH_TOKEN }}'
-
-    - name: Set up and use the "ci" devShell
-      uses: nicknovitski/nix-develop@v1
-      with:
-        arguments: ".#ci"
-
-    # Technically, we don't need this, given we're in a Nix shell;
-    # but we will keep it for the caching.
-    - name: 🚧 Setup Node.js
-      uses: actions/setup-node@v4
-      with:
-        node-version: 18
-        cache: 'yarn'
-        cache-dependency-path: docs/yarn.lock
-
-    - name: 📥 Download benchmark results
-      uses: actions/download-artifact@v5
-      with:
-        path: docs/benchmarks
-        pattern: benchmarks-*
-        merge-multiple: true
-
-    - name: 📥 Download haddock documentation
-      uses: actions/download-artifact@v5
-      with:
-        name: haddocks
-        path: docs/static/haddock
-
-    - name: 📥 Download specification PDF
-      uses: actions/download-artifact@v5
-      with:
-        name: hydra-spec
-        path: docs/static/
-
-    - name: 📚 Documentation sanity check
-      working-directory: docs
-      run: |
-        yarn
-        yarn build-dev
-
-
-  # Compute the cost difference between this branch and master.
-  tx-cost-diff:
-    name: Compute cost differences
-    runs-on: ubuntu-latest
-    # Only run on PR
-    if: github.event_name == 'pull_request'
-    steps:
-    - name: "Checkout the PR as the 'new' source"
-      uses: actions/checkout@v4
-
-    - name: ❄ Setup Nix/Cachix
-      uses: ./.github/actions/nix-cachix-setup
-      with:
-        authToken: '${{ secrets.CACHIX_CARDANO_SCALING_AUTH_TOKEN }}'
-
-    - name: Set up and use the "ci" devShell
-      uses: nicknovitski/nix-develop@v1
-      with:
-        arguments: ".#costDifferences"
-
-    - name: "Compute the difference markdown"
-      run: |
-        nix run ".#tx-cost-diff"
-
-    - name: 🔎 Find Comment
-      uses: peter-evans/find-comment@v3
-      id: find-comment
-      with:
-        issue-number: ${{ github.event.pull_request.number }}
-        comment-author: 'github-actions[bot]'
-        body-includes: Transaction cost differences
-
-    - name: ✏ Create or update comment
-      uses: peter-evans/create-or-update-comment@v4
-      with:
-        comment-id: ${{ steps.find-comment.outputs.comment-id }}
-        edit-mode: replace
-        issue-number: ${{ github.event.pull_request.number }}
-        body-file: diff.md
diff --git a/.github/workflows/docs.yaml b/.github/workflows/docs.yaml
@@ -0,0 +1,28 @@
+name: "Documentation"
+
+on:
+  merge_group:
+  push:
+    branches:
+    - master
+    - release
+  pull_request:
+  workflow_dispatch:
+
+jobs:
+  documentation:
+    name: Documentation
+    runs-on: ubuntu-latest
+    steps:
+    - name: 📥 Checkout repository
+      uses: actions/checkout@v4
+
+    - name: ❄ Setup Nix/Cachix
+      uses: ./.github/actions/nix-cachix-setup
+      with:
+        authToken: '${{ secrets.CACHIX_CARDANO_SCALING_AUTH_TOKEN }}'
+
+    - name: 📚 Build documentation
+      working-directory: docs
+      run: |
+        nix build .#docs
diff --git a/.github/workflows/nix-flake-check.yaml b/.github/workflows/nix-flake-check.yaml
@@ -0,0 +1,30 @@
+name: Nix Flake Check
+
+on:
+  merge_group:
+  pull_request:
+
+jobs:
+  quality:
+    name: Nix Flake Check
+    runs-on: ubuntu-latest
+    steps:
+    - name: Reclaim the bytes
+      uses: data-intuitive/reclaim-the-bytes@v2
+      with:
+        # NOTE: Remove more when needed, but these take also time
+        # See https://github.com/marketplace/actions/reclaim-the-bytes
+        remove-android-sdk: false
+        remove-docker-images: false
+
+    - name: 📥 Checkout repository
+      uses: actions/checkout@v4
+
+    - name: ❄ Setup Nix/Cachix
+      uses: ./.github/actions/nix-cachix-setup
+      with:
+        authToken: '${{ secrets.CACHIX_CARDANO_SCALING_AUTH_TOKEN }}'
+
+    - name: 📐 Check
+      run: |
+        nix flake check -L
diff --git a/.github/workflows/publish-docs.yaml b/.github/workflows/publish-docs.yaml
@@ -29,11 +29,6 @@ jobs:
       with:
         authToken: '${{ secrets.CACHIX_CARDANO_SCALING_AUTH_TOKEN }}'
 
-    - name: Set up and use the "ci" devShell
-      uses: nicknovitski/nix-develop@v1
-      with:
-        arguments: ".#ci"
-
     - name: Get released workflow run id
       id: released-workflow
       uses: actions/github-script@v7
@@ -62,14 +57,6 @@ jobs:
           });
           return res.data.workflow_runs[0].id;
 
-    - name: 📥 Download released hydra-spec
-      uses: actions/download-artifact@v5
-      with:
-        github-token: ${{ secrets.GITHUB_TOKEN || github.token }}
-        run-id: ${{steps.released-workflow.outputs.result}}
-        name: hydra-spec
-        path: docs/static
-
     - name: 📥 Download released benchmarks
       uses: actions/download-artifact@v5
       with:
@@ -79,26 +66,12 @@ jobs:
         merge-multiple: true
         path: docs/benchmarks
 
-    - name: 📥 Download released haddock documentation
-      uses: actions/download-artifact@v5
-      with:
-        github-token: ${{ secrets.GITHUB_TOKEN || github.token }}
-        run-id: ${{steps.released-workflow.outputs.result}}
-        name: haddocks
-        path: docs/static/haddock
-
     - name: Build documentation
       working-directory: docs
       run: |
-        # Only warn on broken links here as the individual documentation builds
-        # should have failed with broken links originally.
-        sed -i 's|onBrokenLinks: "throw"|onBrokenLinks: "warn"|' docusaurus.config.js
+        nix build .#docs
 
-        yarn
-        yarn build
-
-        mkdir -p /tmp/public
-        mv build /tmp/public/head-protocol
+        cp result/build /tmp/public/head-protocol -r
         # Clean the working copy
         git clean -dxf
 
@@ -108,14 +81,6 @@ jobs:
         git reset origin/master --hard
         sed -i 's|head-protocol|head-protocol/unstable|' docusaurus.config.js
 
-    - name: 📥 Download latest hydra-spec
-      uses: actions/download-artifact@v5
-      with:
-        github-token: ${{ secrets.GITHUB_TOKEN || github.token }}
-        run-id: ${{steps.latest-workflow.outputs.result}}
-        name: hydra-spec
-        path: docs/static
-
     - name: 📥 Download latest benchmarks
       uses: actions/download-artifact@v5
       with:
@@ -125,21 +90,12 @@ jobs:
         merge-multiple: true
         path: docs/benchmarks
 
-    - name: 📥 Download latest haddock documentation
-      uses: actions/download-artifact@v5
-      with:
-        github-token: ${{ secrets.GITHUB_TOKEN || github.token }}
-        run-id: ${{steps.latest-workflow.outputs.result}}
-        name: haddocks
-        path: docs/static/haddock
-
     - name: Build /unstable documentation
       working-directory: docs
       run: |
-        yarn
-        yarn build
+        nix build .#docs
 
-        mv build /tmp/public/head-protocol/unstable
+        cp result/build /tmp/public/head-protocol/unstable/ -r
 
     - name: 👉 Create redirects
       run: |
diff --git a/.github/workflows/tx-cost-diff.yaml b/.github/workflows/tx-cost-diff.yaml
@@ -0,0 +1,55 @@
+name: "Compute cost differences"
+
+on:
+  merge_group:
+  push:
+    branches:
+    - master
+    - release
+  pull_request:
+  workflow_dispatch:
+
+permissions:
+  checks: write
+  pull-requests: write
+
+jobs:
+  # Compute the cost difference between this branch and master.
+  tx-cost-diff:
+    name: Compute cost differences
+    runs-on: ubuntu-latest
+    # Only run on PR
+    if: github.event_name == 'pull_request'
+    steps:
+    - name: "Checkout the PR as the 'new' source"
+      uses: actions/checkout@v4
+
+    - name: ❄ Setup Nix/Cachix
+      uses: ./.github/actions/nix-cachix-setup
+      with:
+        authToken: '${{ secrets.CACHIX_CARDANO_SCALING_AUTH_TOKEN }}'
+
+    - name: Set up and use the "ci" devShell
+      uses: nicknovitski/nix-develop@v1
+      with:
+        arguments: ".#costDifferences"
+
+    - name: "Compute the difference markdown"
+      run: |
+        nix run ".#tx-cost-diff"
+
+    - name: 🔎 Find Comment
+      uses: peter-evans/find-comment@v3
+      id: find-comment
+      with:
+        issue-number: ${{ github.event.pull_request.number }}
+        comment-author: 'github-actions[bot]'
+        body-includes: Transaction cost differences
+
+    - name: ✏ Create or update comment
+      uses: peter-evans/create-or-update-comment@v4
+      with:
+        comment-id: ${{ steps.find-comment.outputs.comment-id }}
+        edit-mode: replace
+        issue-number: ${{ github.event.pull_request.number }}
+        body-file: diff.md
diff --git a/nix/hydra/docs.nix b/nix/hydra/docs.nix
