Move docs to luacs-docs/{lua,cs,landing-page}

luacs-docs/cs also has a proper http server for testing locally
This commit is contained in:
peelz
2022-08-03 21:34:42 -04:00
parent 53ea2b8973
commit 1bb7843811
136 changed files with 2208 additions and 2113 deletions
+34 -40
View File
@@ -1,8 +1,17 @@
# yaml-language-server: $schema=https://json.schemastore.org/github-workflow.json
name: Update documentation
on:
workflow_dispatch:
env:
CI_DEPLOY_DIR: luacs-docs/ci-deploy
CI_ARTIFACTS_DIR: luacs-docs/ci-artifacts
DOCS_LUA_ROOT: luacs-docs/lua
DOCS_CS_ROOT: luacs-docs/cs
DOCS_LANDINGPAGE_ROOT: luacs-docs/landing-page
jobs:
update-docs-lua:
runs-on: ubuntu-latest
@@ -19,22 +28,23 @@ jobs:
- uses: leafo/gh-actions-luarocks@v4
- name: Run install script
working-directory: docs
working-directory: ${{ env.DOCS_LUA_ROOT }}
run: ./scripts/install.sh
- name: Run build script
working-directory: docs
working-directory: ${{ env.DOCS_LUA_ROOT }}
run: ./scripts/build.sh
- name: Create tarball
working-directory: docs/html
run: tar -czf ../../docs-lua.tar.gz .
run: |
mkdir -p "$CI_ARTIFACTS_DIR"
tar -czf "$CI_ARTIFACTS_DIR"/lua.tar.gz -C "$DOCS_LUA_ROOT"/build .
- name: Upload tarball
uses: actions/upload-artifact@v3
with:
name: docs-lua
path: docs-lua.tar.gz
path: ${{ env.CI_ARTIFACTS_DIR }}/lua.tar.gz
update-docs-cs:
runs-on: ubuntu-latest
@@ -42,38 +52,23 @@ jobs:
- name: Checkout branch
uses: actions/checkout@v3
- name: Create directories
run: |
mkdir -p doxygen/build/baro-server
mkdir -p doxygen/build/baro-client
- name: Install doxygen
run: sudo apt-get update && sudo apt-get install -y doxygen
- name: Build server documentation
uses: mattnotmitt/doxygen-action@v1
with:
working-directory: 'doxygen/baro-server'
doxyfile-path: './Doxyfile'
- name: Build client documentation
uses: mattnotmitt/doxygen-action@v1
with:
working-directory: 'doxygen/baro-client'
doxyfile-path: './Doxyfile'
- name: Build containing documentation
uses: mattnotmitt/doxygen-action@v1
with:
working-directory: 'doxygen/'
doxyfile-path: './Doxyfile'
- name: Run build script
working-directory: ${{ env.DOCS_CS_ROOT }}
run: ./scripts/build.sh
- name: Create tarball
working-directory: doxygen/build
run: tar -czf ../../docs-cs.tar.gz .
run: |
mkdir -p "$CI_ARTIFACTS_DIR"
tar -czf "$CI_ARTIFACTS_DIR"/cs.tar.gz -C "$DOCS_CS_ROOT"/build .
- name: Upload tarball
uses: actions/upload-artifact@v3
with:
name: docs-cs
path: docs-cs.tar.gz
path: ${{ env.CI_ARTIFACTS_DIR }}/cs.tar.gz
deploy-docs:
runs-on: ubuntu-latest
@@ -82,33 +77,32 @@ jobs:
- name: Checkout branch
uses: actions/checkout@v3
- run: mkdir -p docs_deploy
- run: mkdir -p "$CI_ARTIFACTS_DIR" "$CI_DEPLOY_DIR"
- name: "Download build artifacts: lua docs"
uses: actions/download-artifact@v3
with:
name: docs-lua
path: docs_deploy
path: ${{ env.CI_ARTIFACTS_DIR }}
- name: "Download build artifacts: cs docs"
uses: actions/download-artifact@v3
with:
name: docs-cs
path: docs_deploy
- name: Copy landing page files
run: cp -r docs-landing-page/. docs_deploy/public
path: ${{ env.CI_ARTIFACTS_DIR }}
- name: Extract lua and cs tarballs
working-directory: docs_deploy
run: |
mkdir -p public/lua-docs public/cs-docs
tar -xzf docs-lua.tar.gz -C public/lua-docs
tar -xzf docs-cs.tar.gz -C public/cs-docs
mkdir -p "$CI_DEPLOY_DIR"/{lua,cs}-docs
tar -xzf "$CI_ARTIFACTS_DIR"/lua.tar.gz -C "$CI_DEPLOY_DIR"/lua-docs
tar -xzf "$CI_ARTIFACTS_DIR"/cs.tar.gz -C "$CI_DEPLOY_DIR"/cs-docs
- name: Copy landing page files
run: cp -r "$DOCS_LANDINGPAGE_ROOT"/. "$CI_DEPLOY_DIR"
- name: Deploy
uses: peaceiris/actions-gh-pages@v3
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
publish_dir: docs_deploy/public
publish_dir: ${{ env.CI_DEPLOY_DIR }}
keep_files: true