--- a +++ b/.github/workflows/gh-docs-deploy.yml @@ -0,0 +1,41 @@ +name: gh-pages-docs-deploy + +on: + push: + branches: [main] + pull_request: + branches: [main] + merge_group: + types: [checks_requested] + +jobs: + build-and-deploy: + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v4 + - uses: actions/setup-python@v5 + with: + python-version: 3.x + - name: Cache dependencies + uses: actions/cache@v4 + with: + path: ~/.cache/pip + key: ${{ runner.os }}-pip-${{ hashFiles('docs/requirements.txt') }} + restore-keys: | + ${{ runner.os }}-pip- + - name: Install dependencies + run: | + python -m pip install --upgrade pip + pip install -r docs/requirements.txt + - name: Build site + run: mkdocs build + working-directory: docs + - name: Configure Git Credentials + if: github.event_name == 'push' + run: | + git config user.name github-actions[bot] + git config user.email 41898282+github-actions[bot]@users.noreply.github.com + - name: Deploy + if: github.event_name == 'push' + run: mkdocs gh-deploy --force + working-directory: docs