build.yml

name: Build & Publish Release Notes
on:
  workflow_dispatch:
  push:
    tags:
      - 'release/*'

jobs:
  sphinx-it-up:
    runs-on: ubuntu-latest
    steps:
    - uses: actions/checkout@v2

    - name: Get All Tags
      run: |
       git fetch --prune --unshallow --tags

    - name: Install Dependencies
      run: |
        pip install -r requirements.txt

    - name: Build Sphinx
      run: |
        cd ./docs
        export LC_ALL=C
        make dev

    - name: Commit Release Files
      run: |
        git config --global user.name ${{ secrets.GIT__USER_NAME }}
        git config --global user.email ${{ secrets.GIT__USER_EMAIL }}
        git add ./docs/source/* || true
        git status || true
        git commit -m "bot(release): commit release files;" || true
        git push origin HEAD:main --force || true

    - name: Publish to GitHub Pages
      uses: peaceiris/actions-gh-pages@v4
      with:
        github_token: ${{ secrets.GITHUB_TOKEN }}
        publish_dir: ./docs/build/html
        user_name: ${{ secrets.GIT__USER_NAME }}
        user_email: ${{ secrets.GIT__USER_EMAIL }}