mirror of
https://github.com/pinnacle-comp/pinnacle.git
synced 2024-12-27 21:58:18 +01:00
52 lines
1.5 KiB
YAML
52 lines
1.5 KiB
YAML
# From https://github.com/lunarmodules/ldoc/blob/master/.github/workflows/doc.yml
|
|
|
|
# Based on https://gist.github.com/domenic/ec8b0fc8ab45f39403dd
|
|
name: Build Lua Docs
|
|
on:
|
|
pull_request:
|
|
branches:
|
|
- main
|
|
paths:
|
|
- "api/lua/**"
|
|
push:
|
|
branches:
|
|
- main
|
|
paths:
|
|
- "api/lua/**"
|
|
workflow_dispatch:
|
|
|
|
env:
|
|
BRANCH_NAME: ${{ github.head_ref || github.ref_name }}
|
|
|
|
jobs:
|
|
build-docs:
|
|
name: Build Lua docs
|
|
runs-on: ubuntu-latest
|
|
steps:
|
|
- name: Checkout
|
|
uses: actions/checkout@v4
|
|
- name: Get ldoc_gen
|
|
uses: actions/checkout@v4
|
|
with:
|
|
repository: Ottatop/ldoc_gen
|
|
path: ./ldoc_gen
|
|
- name: Setup Lua
|
|
uses: leafo/gh-actions-lua@v10
|
|
with:
|
|
luaVersion: "5.4"
|
|
- name: Setup Lua Rocks
|
|
uses: leafo/gh-actions-luarocks@v4
|
|
- name: Setup dependencies
|
|
run: luarocks install ldoc
|
|
- name: Generate LDoc compatible code
|
|
run: mv ldoc_gen .. && cd ../ldoc_gen && cargo run -- -p ../pinnacle/api/lua
|
|
- name: Build docs
|
|
run: cd ../ldoc_gen/.ldoc_gen && cp ../../pinnacle/resources/ldoc.css ../../pinnacle/resources/config.ld . && ldoc .
|
|
- name: Deploy
|
|
uses: peaceiris/actions-gh-pages@v3
|
|
with:
|
|
deploy_key: ${{ secrets.DOCS_DEPLOY_KEY_LUA }}
|
|
external_repository: pinnacle-comp/lua-reference
|
|
publish_dir: ../ldoc_gen/.ldoc_gen/doc
|
|
destination_dir: ${{ env.BRANCH_NAME }}
|
|
# force_orphan: true
|