deploy.yaml

name: deploy

on:
  push:
    branches:
      - master

jobs:
  deploy:
    runs-on: ubuntu-latest

    steps:
      - name: Checkout repository
        uses: actions/checkout@v4

      - name: Set up Python
        uses: actions/setup-python@v5
        with:
          python-version: "3.11"
          cache: "pip"
          cache-dependency-path: ./requirements.txt

      - name: Install dependencies
        run: |
          python -m pip install --upgrade pip
          pip install -r requirements.txt

      - name: Check for changes in docs/ or mkdocs.yml
        id: check_changes
        run: |
          if [ "$(git diff --quiet origin/master -- docs/ mkdocs.yml; echo $?)" -eq 0 ];
          then
            echo "changes_detected=false" >> $GITHUB_ENV
            echo "No changes to docs/ and mkdocs.yml - exiting the build.";
          else
            echo "changes_detected=true" >> $GITHUB_ENV
            echo "Changes detected in docs/ or mkdocs.yml - continuing the build.";
          fi

      - name: Set up Node.js
        if: env.changes_detected == 'true'
        uses: actions/setup-node@v4
        with:
          node-version: "18"
          cache: "npm"
          cache-dependency-path: ./package.json

      - name: Install markdownlint-cli
        if: env.changes_detected == 'true'
        run: npm install -g markdownlint-cli

      - name: Lint Markdown files
        if: env.changes_detected == 'true'
        run: markdownlint **/*.md

      - name: Build MkDocs site
        if: env.changes_detected == 'true'
        run: mkdocs build

      - name: Install Ruby and Bundler
        if: env.changes_detected == 'true'
        run: sudo apt-get install -y ruby-full

      - name: Install HTML Proofer
        if: env.changes_detected == 'true'
        run: gem install html-proofer

      - name: Test MkDocs site
        if: env.changes_detected == 'true'
        run: htmlproofer ./site --only-4xx --check-html --check-img-http --check-favicon --check-external-hash --check-opengraph --check-opengraph-image

      - name: Deploy to GitHub Pages
        if: env.changes_detected == 'true'
        uses: peaceiris/actions-gh-pages@v4
        with:
          github_token: ${{ secrets.GITHUB_TOKEN }}
          publish_dir: ./site
          keep_files: false
          destination_dir: .
          user_name: "github-actions[bot]"
          user_email: "github-actions[bot]@users.noreply.github.com"
          publish_branch: gh-pages
          full_commit_message: ${{ github.event.head_commit.message }}