-
-
Notifications
You must be signed in to change notification settings - Fork 1
40 lines (33 loc) · 977 Bytes
/
docs.yml
File metadata and controls
40 lines (33 loc) · 977 Bytes
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
name: Publish API Documentation
on:
workflow_dispatch:
push:
tags:
- 'v*'
permissions:
contents: write
jobs:
deploy-docs:
runs-on: ubuntu-latest
steps:
- name: Checkout Repository
uses: actions/checkout@v4
- name: Install Zig
uses: goto-bus-stop/setup-zig@v2
with:
version: '0.15.2'
- name: Install System Dependencies
run: |
sudo apt-get update
sudo apt-get install -y make
- name: Generate Documentation
run: make docs
- name: Deploy to GitHub Pages
uses: peaceiris/actions-gh-pages@v4
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
publish_dir: ./zig-out/docs
publish_branch: gh-pages
user_name: ${{ github.actor }}
user_email: ${{ github.actor }}@users.noreply.github.com
commit_message: "docs: Deploy documentation from ${{ github.sha }} by ${{ github.actor }}"