evennia/.github/workflows/github_action_build_docs.yml

# This github-Evennia workflow will build the docs.

name: documentation

on:
  push:
    branches: [ master, develop ]
    paths:
      - 'docs/**'
      - 'evennia/contrib/**'
  pull_request:
    branches: [ master, develop ]
    paths:
      - 'docs/**'
      - 'evennia/contrib/**'

jobs:
  build:
    runs-on: ubuntu-latest

    strategy:
      matrix:
        python-version: ['3.9']

    steps:
      - name: Checkout 0.9.5 branch 
        uses: actions/checkout@v2
        with:
            ref: v0.9.5

      - name: Checkout ${{ github.ref }} branch 
        uses: actions/checkout@v2

      - name: Set up Python ${{ matrix.python-version }}
        uses: actions/setup-python@v4
        with:
          python-version: ${{ matrix.python-version }}
          cache: pip

      - name: Install doc-building dependencies
        run: |
          python -m pip install --upgrade pip
          cd docs/
          make install

      # full game dir needed for mv-local
      - name: Set up evennia game dir
        run: |
          pip install -e .
          pip install -r requirements_extra.txt
          cd ..
          evennia --init gamedir
          cd gamedir
          evennia migrate

      - name: Build and deploy docs (only from master/develop branch)
        if: ${{ github.ref == 'refs/heads/develop' || github.ref == 'refs/heads/master'}}
        run: |
          git config --global user.email "docbuilder@evennia.com"
          git config --global user.name "Evennia docbuilder action"
          git branch
          cd docs
          make release