docs.yml

name: Documentation
on:
  push:
    branches:
      - master
      - 'releases/**'
  workflow_dispatch: ~

concurrency:
  group: ci-${{github.actor}}-${{github.head_ref || github.run_number}}-${{github.ref}}-docs
  cancel-in-progress: true

permissions:
  contents: read
  pages: write
  id-token: write

jobs:
  docs:
    name: 📖 Documentation
    runs-on: ubuntu-latest
    strategy:
      fail-fast: true
    env:
      HOST: linux
      PLATFORM: linux-clang
      BUILD_TYPE: dbg
      LIB_TYPE: shared
      ARCH: 64
      DBE_TAG: master
      URHO3D_DOCS: 1
      USE_CCACHE: 1
      LLVM_USE_SPLIT_DWARF: 1
      LLVM_ENABLE_ASSERTIONS: 1
    steps:
      - name: Checkout
        uses: actions/checkout@v3
        with: { fetch-depth: 0 }
      - name: Source checksum
        id: source_checksum
        run: rake source_checksum
      - name: Cache
        uses: actions/cache@v3
        with:
          path: |
            build/cache/.ccache
          key: |
            ${{ env.PLATFORM }}-${{ env.LIB_TYPE }}-${{ env.ARCH }}-${{ env.BUILD_TYPE }}-${{ env.DBE_TAG }}-${{ steps.source_checksum.outputs.hexdigest }}
          restore-keys: |
            ${{ env.PLATFORM }}-${{ env.LIB_TYPE }}-${{ env.ARCH }}-${{ env.BUILD_TYPE }}-${{ env.DBE_TAG }}
            ${{ env.PLATFORM }}-${{ env.LIB_TYPE }}-${{ env.ARCH }}-${{ env.BUILD_TYPE }}
      - name: CMake
        run: script/dockerized.sh ${PLATFORM/-*} rake cmake
      - name: Documentation
        run: script/dockerized.sh ${PLATFORM/-*} rake doc
      - name: Deploy Documentation to Pages
        uses: peaceiris/actions-gh-pages@v3
        with:
          github_token: ${{ secrets.GITHUB_TOKEN }}
          publish_dir: ./Docs/html/
          destination_dir: docs