Update documentation #1
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| # 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 | |
| steps: | |
| - name: Checkout branch | |
| uses: actions/checkout@692973e3d937129bcbf40652eb9f2f61becf3332 # v4.1.7 | |
| with: | |
| submodules: recursive | |
| - name: Setup .NET | |
| uses: actions/setup-dotnet@6bd8b7f7774af54e05809fcc5431931b3eb1ddee # v4.0.1 | |
| with: | |
| dotnet-version: | | |
| 6.0.x | |
| - uses: leafo/gh-actions-lua@35bcb06abec04ec87df82e08caa84d545348536e # v10.0.0 | |
| with: | |
| luaVersion: "5.2" | |
| - uses: leafo/gh-actions-luarocks@e65774a6386cb4f24e293dca7fc4ff89165b64c5 # v4.3.0 | |
| - name: Run install script | |
| working-directory: ${{ env.DOCS_LUA_ROOT }} | |
| run: ./scripts/install.sh | |
| - name: Run docs generator script | |
| working-directory: ${{ env.DOCS_LUA_ROOT }} | |
| run: ./scripts/generate_docs.sh | |
| - name: Run build script | |
| working-directory: ${{ env.DOCS_LUA_ROOT }} | |
| run: ./scripts/build.sh | |
| - name: Create tarball | |
| 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@834a144ee995460fba8ed112a2fc961b36a5ec5a # v4.3.6 | |
| with: | |
| name: docs-lua | |
| path: ${{ env.CI_ARTIFACTS_DIR }}/lua.tar.gz | |
| update-docs-cs: | |
| runs-on: ubuntu-latest | |
| steps: | |
| - name: Checkout branch | |
| uses: actions/checkout@692973e3d937129bcbf40652eb9f2f61becf3332 # v4.1.7 | |
| - name: Install doxygen | |
| run: sudo apt-get update && sudo apt-get install -y doxygen | |
| - name: Run build script | |
| working-directory: ${{ env.DOCS_CS_ROOT }} | |
| run: ./scripts/build.sh | |
| - name: Create tarball | |
| 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@834a144ee995460fba8ed112a2fc961b36a5ec5a # v4.3.6 | |
| with: | |
| name: docs-cs | |
| path: ${{ env.CI_ARTIFACTS_DIR }}/cs.tar.gz | |
| deploy-docs: | |
| runs-on: ubuntu-latest | |
| needs: [update-docs-lua, update-docs-cs] | |
| steps: | |
| - name: Checkout branch | |
| uses: actions/checkout@692973e3d937129bcbf40652eb9f2f61becf3332 # v4.1.7 | |
| - run: mkdir -p "$CI_ARTIFACTS_DIR" "$CI_DEPLOY_DIR" | |
| - name: "Download build artifacts: lua docs" | |
| uses: actions/download-artifact@fa0a91b85d4f404e444e00e005971372dc801d16 # v4.1.8 | |
| with: | |
| name: docs-lua | |
| path: ${{ env.CI_ARTIFACTS_DIR }} | |
| - name: "Download build artifacts: cs docs" | |
| uses: actions/download-artifact@fa0a91b85d4f404e444e00e005971372dc801d16 # v4.1.8 | |
| with: | |
| name: docs-cs | |
| path: ${{ env.CI_ARTIFACTS_DIR }} | |
| - name: Extract lua and cs tarballs | |
| run: | | |
| 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@4f9cc6602d3f66b9c108549d475ec49e8ef4d45e #v4.0.0 | |
| with: | |
| github_token: ${{ secrets.GITHUB_TOKEN }} | |
| publish_dir: ${{ env.CI_DEPLOY_DIR }} | |
| keep_files: true |