Skip to content

Add an AGENTS.md file (#15) #9

Add an AGENTS.md file (#15)

Add an AGENTS.md file (#15) #9

Workflow file for this run

name: Publish API documentation
on:
workflow_dispatch:
push:
tags:
- 'v*'
concurrency:
group: ${{ github.workflow }}-${{ github.ref }}
cancel-in-progress: true
permissions:
contents: write
jobs:
deploy-docs:
runs-on: ubuntu-latest
steps:
- name: Checkout repository
uses: actions/checkout@v4
- name: Install Zig 0.16.0
run: |
curl -sSfL https://ziglang.org/download/0.16.0/zig-x86_64-linux-0.16.0.tar.xz | tar -xJ
echo "$PWD/zig-x86_64-linux-0.16.0" >> "$GITHUB_PATH"
- name: Install 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: ./docs/api
publish_branch: gh-pages
user_name: 'github-actions[bot]'
user_email: 'github-actions[bot]@users.noreply.github.com'
commit_message: "docs: Deploy documentation from ${{ github.sha }}"