actions.yml

name: Auto-build docs
run-name: Build and publish documentation
on: [push]
jobs:
  # Build job
  build:
    runs-on: ubuntu-latest
    steps:
      - run: echo "🎉 The job was automatically triggered by a ${{ github.event_name }} event."
      - run: echo "🐧 This job is now running on a ${{ runner.os }} server hosted by GitHub!"
      - run: echo "🔎 The name of your branch is ${{ github.ref }} and your repository is ${{ github.repository }}."
      - name: Check out repository code
        uses: actions/checkout@v4
      - run: echo "💡 The ${{ github.repository }} repository has been cloned to the runner."
      - run: echo "🖥️ The workflow is now ready to test your code on the runner."
      - uses: ruby/setup-ruby@v1
          with:
            bundler-cache: true # runs 'bundle install' and caches installed gems automatically
      - run: bundle exec yard --output-dir github-pages
      - name: List files in the repository
        run: |
          ls ${{ github.workspace }}
      - uses: actions/upload-artifact@v4
        with:
          # Name of the artifact to upload.
          name: "yard docs" # upload the doc directory that yard just created

          # A file, directory or wildcard pattern that describes what to upload
          # Required.
          path: github-pages

      - run: echo "🍏 This job's status is ${{ job.status }}."
  # Deploy job
  deploy:
    # Add a dependency to the build job
    needs: build

    # 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@v4 # or specific "vX.X.X" version tag for this action