deploy.yml

name: Deploy

on:
  workflow_dispatch:
  repository_dispatch:
  push:
    branches:
      - master

jobs:
  build-and-deploy:
    permissions:
      contents: write
    runs-on: ubuntu-22.04
    steps:
    - uses: actions/checkout@v4
      with:
        fetch-depth: 0

    - name: Update and set up
      run: |
        sudo apt-get -y update
        sudo apt-get install -y python3-pip git

    - name: giscus identifier check
      run: |
        python3 scripts/giscus-uuid-check.py docs/source > /dev/null

    - name: Build
      run: |
        pip3 install pipenv
        pipenv update
        pipenv run sphinx-build --fail-on-warning --fresh-env --jobs auto --html-define SPHINXPRODUCTION=True docs/source docs/build
        date -u +%Y-%m-%d-%T-%Z > docs/build/build.info.txt
        echo "${{ github.sha }}" > docs/build/sha.txt
        cat Pipfile.lock >> docs/build/build.info.txt
        touch docs/build/.nojekyll

    - name: Deploy 🚀
      uses: JamesIves/github-pages-deploy-action@v4.6.0
      with:
        dry-run: false
        token: ${{ secrets.GITHUB_TOKEN }}
        branch: gh-pages # The branch the action should deploy to.
        folder: docs/build # The folder the action should deploy.
        clean: true # Automatically remove deleted files from the deploy branch
        single-commit: true # Like push force, keep only the last commit
        git-config-name: #use username that pushes to master
        git-config-email: <>