docs.yml

name: Make Documentation

on:
  push:
    branches: ["main"]
    tags: ["*"]

env:
  GIT_COMMITTER_NAME: "github-actions[bot]"
  GIT_COMMITTER_EMAIL: "41898282+github-actions[bot]@users.noreply.github.com"

defaults:
  run:
    shell: bash

permissions:
  contents: write

jobs:
  documentation:
    runs-on: ${{ matrix.os }}
    strategy:
      fail-fast: false
      matrix:
        os: [ ubuntu-latest ]
        python-version: [ "3.x" ]
    steps:
    - uses: actions/checkout@v4
    - uses: ./.github/actions/bootstrap-environ
      id: bootstrap-environ
      with:
        python-version: ${{ matrix.python-version }}
        runner: ${{ matrix.os }}
    - name: Setup Git Credentials
      run: |
        git config --global user.email "41898282+github-actions[bot]@users.noreply.github.com"
        git config --global user.name "github-actions[bot]"
    - name: Update the Changelog
      run: |
        make changelog
        git push origin ${{ github.ref_name }}
    - name: Build the Docs
      run: make docs