documentation.yml

name: Documentation

on:
  release:
    types: [published]
  push:
    branches: [main]

jobs:
  deploy_docs:
    runs-on: macos-latest
    steps:
      - name: Checkout repository
        uses: actions/checkout@v4

      - name: Setup Ruby
        uses: ruby/setup-ruby@v1
        with:
          # runs 'bundle install' and caches installed gems automatically
          bundler-cache: true

      - name: Generate Documentation
        run: |
          sed  -i.bak "s/title:\(.*\)/title:\1 (${{ github.ref_name }})/g" .jazzy.yaml
          bundle exec jazzy

      - name: Fix Invalid URLs
        run: |
          cd docs
          touch .nojekyll

      - name: Commit files
        run: |
          cd docs
          git init
          git config --local user.email "action@github.com"
          git config --local user.name "GitHub Action"
          git add .
          git commit -m "Deploying updated Jazzy documentation"

      - name: Push changes
        uses: ad-m/github-push-action@master
        with:
          directory: docs
          github_token: ${{ secrets.GITHUB_TOKEN }}
          branch: gh-pages
          force: true