universal-agent-runtime/.github/workflows/docs.yml at main · Prometheus-AGS/universal-agent-runtime · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
name: Deploy documentation

on:
  push:
    branches: [main]
    paths:
      - "website/**"
      - "docs/**"
      - "sdks/**"
      - "src/**"
      - "crates/**"
      - "Cargo.toml"
      - "Cargo.lock"
      - "scripts/stage-documentation-references.mjs"
      - ".github/workflows/docs.yml"
  workflow_dispatch:

permissions:
  contents: read
  pages: write
  id-token: write

concurrency:
  group: pages
  cancel-in-progress: false

jobs:
  build:
    name: Assemble Pages artifact
    runs-on: ubuntu-latest
    steps:
      - name: Checkout source and submodules
        uses: actions/checkout@v7
        with:
          submodules: recursive
          token: ${{ secrets.SUBMODULES_TOKEN || github.token }}

      - name: Install Node.js
        uses: actions/setup-node@v7
        with:
          node-version: 24
          cache: npm
          cache-dependency-path: |
            website/package-lock.json
            sdks/typescript/package-lock.json

      - name: Install portal dependencies
        run: npm --prefix website ci

      - name: Build Docusaurus portal
        run: npm --prefix website run build

      - name: Install Rust toolchain
        uses: dtolnay/rust-toolchain@stable
        with:
          toolchain: stable

      - name: Install Protocol Buffers compiler
        run: sudo apt-get update && sudo apt-get install --yes protobuf-compiler

      - name: Generate Rust reference
        run: cargo doc --locked --no-deps -p universal-agent-runtime --lib --features server-full

      - name: Install TypeScript SDK dependencies
        run: npm --prefix sdks/typescript ci

      - name: Generate TypeScript reference
        run: npm --prefix sdks/typescript run docs

      - name: Stage generated references
        run: node scripts/stage-documentation-references.mjs

      - name: Upload Pages artifact
        uses: actions/upload-pages-artifact@v5
        with:
          path: website/build

  deploy:
    name: Deploy and validate Pages artifact
    needs: build
    runs-on: ubuntu-latest
    environment:
      name: github-pages
      url: ${{ steps.deployment.outputs.page_url }}
    steps:
      - name: Deploy to GitHub Pages
        id: deployment
        uses: actions/deploy-pages@v5

      - name: Checkout deployment validator
        uses: actions/checkout@v7
        with:
          sparse-checkout: |
            docs/publication/routes.json
            scripts/validate-deployed-documentation.mjs
          sparse-checkout-cone-mode: false

      - name: Install Node.js for deployment validation
        uses: actions/setup-node@v7
        with:
          node-version: 24

      - name: Validate deployed documentation routes
        env:
          UAR_DOCS_BASE_URL: ${{ steps.deployment.outputs.page_url }}
        run: node scripts/validate-deployed-documentation.mjs --base-url "$UAR_DOCS_BASE_URL"