mkdocs-test.yml

name: mkdocs-test

on: pull_request

jobs:
  test-docs-build:
    runs-on: ubuntu-latest

    steps:
      - name: Checkout main repo
        uses: actions/checkout@v4
        with:
          fetch-depth: 0

      - uses: actions/setup-python@v5
        with:
          python-version: "3.10"

      - name: Install ubuntu dependencies
        run: sudo apt-get install -y libxml2-dev libxslt-dev

      - name: install deps
        run: pip3 install -r requirements-docs.txt

      - name: setup git
        run: |
          git config --global user.name Mike
          git config --global user.email mike@docs.hopsworks.ai

      - name: test broken links
        run: |
          # run the server
          mkdocs serve  > /dev/null 2>&1 &
          SERVER_PID=$!
          echo "mk server in PID $SERVER_PID"
          # Give enough time for deployment
          sleep 30
          echo "Launching linkchecker"
          linkchecker --no-warnings --no-status http://127.0.0.1:8000/

          # If ok just kill the server
          kill -9 $SERVER_PID

      - name: mike deploy docs
        run: mike deploy 3.2-SNAPSHOT dev -u