Skip to content

Make the namings consitent (#6) #4

Make the namings consitent (#6)

Make the namings consitent (#6) #4

Workflow file for this run

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: ./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 }}"