docs.yml

name: Docs

on:
  push:
    branches:
      - master

jobs:
  build:
    runs-on: ubuntu-latest
    name: Yard on Ruby ${{ matrix.ruby }}
    strategy:
      matrix:
        ruby:
          - "2.7.8"

    steps:
      - name: Checkout
        uses: actions/checkout@v3
      - name: Set up Ruby
        uses: ruby/setup-ruby@v1
        with:
          ruby-version: ${{ matrix.ruby }}
          bundler-cache: true
          rubygems: "3.4.14"
      - name: Build yard docs
        run: YARD_OUTPUT_DIR="${{ runner.temp }}/doc/" bundle exec rake yard
      - name: Upload Pages artifact
        uses: actions/upload-pages-artifact@v2
        with:
          path: ${{ runner.temp }}/doc

  deploy:
    needs: build
    name: Deploy to GitHub Pages

    # Grant GITHUB_TOKEN the permissions required to make a Pages deployment
    permissions:
      pages: write # to deploy to Pages
      id-token: write # to verify the deployment originates from an appropriate source

    # Deploy to the github-pages environment
    environment:
      name: github-pages
      url: ${{ steps.deployment.outputs.page_url }}

    # Specify runner + deployment step
    runs-on: ubuntu-latest
    steps:
      - name: Deploy to GitHub Pages
        id: deployment
        uses: actions/deploy-pages@v2