deploy.yml

name: Deploy documentation to GitHub Pages 
on:
  push:
    branches:
      - main
    paths-ignore:
      - 'README.md'

permissions:
  contents: write

jobs:
  deploy:
    runs-on: ubuntu-latest

    outputs:
      skipped: ${{ steps.changelog.outputs.skipped }}
      tag: ${{ steps.changelog.outputs.tag }}
      clean_changelog: ${{ steps.changelog.outputs.clean_changelog }}
      version: ${{ steps.changelog.outputs.version }} 

    steps:

      - name: Checkout 🔔
        uses: actions/checkout@v4

      - name: Setup Python 🐍 
        uses: actions/setup-python@v4
        with:
          python-version: 3.x

      - name: Cache repository contents 📦    
        uses: actions/cache@v3
        with:
          key: ${{ github.ref }}
          path: .cache

      - name: Install mkdocs-material 📁    
        run: pip install mkdocs-material

      - name: Install additional pip packages 📦
        run: pip install pillow cairosvg mkdocs-git-authors-plugin mkdocs-git-committers-plugin-2 mkdocs-git-revision-date-localized-plugin mkdocs-minify-plugin

      - name: Deploy to GitHub Pages 🚀 
        run: mkdocs gh-deploy --force

      - name: Conventional Changelog Action 📋
        id: changelog
        uses: TriPSs/conventional-changelog-action@v5
        with:
          github-token: ${{ secrets.GITHUB_TOKEN }}
          git-user-name: "github-actions[bot]"
          git-user-email: "github-actions[bot]@users.noreply.github.com"
          skip-git-pull: "true"
          skip-on-empty: "false"
          release-count: 10
          version-file: package.yaml
          create-summary: true

      - name: Generate Release 📦
        if: ${{ steps.changelog.outputs.skipped == 'false' }}
        uses: softprops/action-gh-release@v2
        with:
          tag_name: ${{ steps.changelog.outputs.tag }}
          name: ${{ steps.changelog.outputs.tag }}
          generate_release_notes: true
          body: ${{ steps.changelog.outputs.clean_changelog }}