.github/workflows/docs.yml


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

name: API Reference

on:
  push:
    branches: [master]

  # Allow manually starting the workflow.
  workflow_dispatch:

# If two concurrent runs are started,
# prefer the latest one.
concurrency:
  group: "pages"
  cancel-in-progress: true

jobs:
  build:
    name: Build website
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v5
      - uses: mlugg/setup-zig@v2
      - name: Build
        run: zig build docs
      - name: Upload
        uses: actions/upload-pages-artifact@v3
        with:
          path: "zig-out/docs/"

  publish:
    name: Publish website
    runs-on: ubuntu-latest
    needs: build # wait for build to finish
    permissions:
      # Request sufficient permissions to publish the website.
      pages: write
      id-token: write
    steps:
      - name: Deploy to GitHub Pages
        id: deployment
        uses: actions/deploy-pages@v4
    environment:
      name: github-pages
      url: ${{ steps.deployment.outputs.page_url }}