2023-06-13 00:17:01 +08:00
|
|
|
name: gendocs
|
2021-07-06 14:40:51 +08:00
|
|
|
|
|
|
|
|
# Controls when the action will run. Triggers the workflow on push or pull request
|
|
|
|
|
# events but only for the master branch
|
|
|
|
|
on:
|
|
|
|
|
push:
|
2021-07-07 02:42:04 +08:00
|
|
|
branches:
|
2023-08-25 16:49:08 +08:00
|
|
|
- 1.x
|
2021-07-06 14:40:51 +08:00
|
|
|
paths:
|
2021-12-31 14:39:08 +08:00
|
|
|
- core/**/*
|
2021-07-06 14:40:51 +08:00
|
|
|
- docs/**/*
|
2023-06-13 00:17:01 +08:00
|
|
|
- .github/workflows/gendocs.yml
|
2023-06-12 11:25:23 +08:00
|
|
|
workflow_dispatch:
|
|
|
|
|
|
2021-07-06 14:40:51 +08:00
|
|
|
jobs:
|
2021-07-06 15:23:55 +08:00
|
|
|
build-docs:
|
2021-07-06 14:40:51 +08:00
|
|
|
runs-on: ubuntu-latest
|
|
|
|
|
|
|
|
|
|
steps:
|
2022-10-20 22:20:33 +08:00
|
|
|
- uses: actions/checkout@v3
|
2021-07-06 14:40:51 +08:00
|
|
|
|
|
|
|
|
# Build the HTML documentation
|
2023-06-12 10:26:08 +08:00
|
|
|
- name: Build HTML documentation
|
2023-06-29 19:46:52 +08:00
|
|
|
shell: pwsh
|
|
|
|
|
run: ./tools/ci/gendocs.ps1
|
2021-07-06 14:40:51 +08:00
|
|
|
|
|
|
|
|
# Deploy the HTML documentation to GitHub Pages
|
|
|
|
|
- name: GH Pages Deployment
|
|
|
|
|
uses: peaceiris/actions-gh-pages@v3
|
|
|
|
|
with:
|
|
|
|
|
github_token: ${{ secrets.GITHUB_TOKEN }}
|
2023-08-25 16:49:08 +08:00
|
|
|
publish_dir: ./docs/html/
|
2021-07-06 14:40:51 +08:00
|
|
|
enable_jekyll: false
|
|
|
|
|
allow_empty_commit: false
|
|
|
|
|
force_orphan: true
|
|
|
|
|
publish_branch: gh-pages
|
