docs.yml

name: docs

on:
  push:
    branches:
    - master
  pull_request:
    branches:
    - master
    paths:
    - '.github/workflows/docs.yml'
    - 'docs/**'
    - 'ddev/**'
    - 'datadog_checks_dev/**'
    - 'mkdocs.yml'
    # We care about changes to base package dependencies because they get installed
    # in the docs virtualenv along with the dependencies of ddev. For example, this PR:
    # https://github.com/DataDog/integrations-core/pull/17319/files#diff-1b02d4258aa29155f48813d2eb55fc87f62abbded6d8a9fa9e3b8f08365d771aR64
    # broke the docs job (pydantic incompatible with ddev's version) but we didn't find out until later.
    - 'datadog_checks_base/pyproject.toml'

jobs:
  build:
    runs-on: ubuntu-latest

    steps:
    - uses: actions/checkout@v4
      with:
        # Fetch all history for applying timestamps to every page
        fetch-depth: 0

    - name: Set up Python
      uses: actions/setup-python@v5
      with:
        python-version: '3.12'
        cache: 'pip'

    - name: Upgrade Python packaging tools
      run: pip install --disable-pip-version-check --upgrade pip setuptools wheel

    - name: Install ddev
      run: |
        pip install -e ./datadog_checks_dev[cli]
        pip install -e ./ddev

    - name: Configure ddev
      run: |
        ddev config set repos.core .
        ddev config set repo core

    - name: Install additional dependencies for the base package
      run: |
        sudo apt-get update
        sudo apt-get install -y --no-install-recommends libkrb5-dev

    - name: Validate documentation
      run: ddev -v docs build --check

    - name: Build documentation
      run: ddev -v docs build

    - uses: actions/upload-artifact@v4
      with:
        name: documentation
        path: site

  publish:
    runs-on: ubuntu-latest

    if: github.event_name == 'push' && github.ref == 'refs/heads/master'
    needs:
    - build

    permissions:
      contents: write
      
    steps:
    - uses: actions/download-artifact@v4
      with:
        name: documentation
        path: site

    - uses: peaceiris/actions-gh-pages@v3
      with:
        github_token: ${{ secrets.GITHUB_TOKEN }}
        publish_dir: ./site
        commit_message: ${{ github.event.head_commit.message }}
        # Write .nojekyll at the root, see:
        # https://help.github.com/en/github/working-with-github-pages/about-github-pages#static-site-generators
        enable_jekyll: false
        # Only deploy if there were changes
        allow_empty_commit: false