docs.yaml

name: Docs
on:
  push:
    branches:
      - "main"
    paths-ignore:
      - "**/*.png"
  pull_request:
    branches:
      - "main"
    paths-ignore:
      - "**/*.png"

jobs:
  docs-lint:
    runs-on: ubuntu-22.04
    steps:
      - name: Check out code
        uses: actions/checkout@v4

      - name: Run markdown linter
        uses: nosborn/github-action-markdown-cli@v3.3.0
        with:
          files: docs/*
          config_file: ".github/markdown_lint_config.json"

  docs-build:
    runs-on: ubuntu-latest
    needs: docs-lint
    steps:
      - uses: actions/checkout@v4
      - uses: ./tools/github-actions/setup-deps

      - name: Generate EG Pages
        run: make docs

      # Upload docs for GitHub Pages
      - name: Upload GitHub Pages artifact
        uses: actions/upload-pages-artifact@v2.0.0
        with:
          # Path of the directory containing the static assets.
          path: docs/html
          # Duration after which artifact will expire in days.
          # retention-days: # optional, default is 1

  # This workflow contains a single job called "build"
  docs-publish:
    if: github.event_name == 'push'
    runs-on: ubuntu-latest
    needs: docs-build

    # Grant GITHUB_TOKEN the permissions required to make a Pages deployment
    permissions:
      pages: write      # to deploy to Pages
      deployments: write
      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 }}

    steps:
      - name: Deploy to GitHub Pages
        id: deployment
        uses: actions/deploy-pages@v2.0.4