rsyslog/.github/workflows/doc_deploy_main.yml

name: Deploy documentation to GitHub Pages

# Builds docs with Google Analytics and deploys to https://<site>/doc/
# Uses rsyslog/rsyslog_dev_doc_base_ubuntu:22.04 Docker container for the Sphinx build.
# Add GOOGLE_ANALYTICS_ID as a repository secret before use.
# Set DOC_BASE_URL repository variable (e.g. https://docs.rsyslog.com) for Sitemap base; otherwise uses github.io URL.

on:
  push:
    branches: [main]
  workflow_dispatch:

concurrency:
  group: doc-deploy-main
  cancel-in-progress: true

jobs:
  build:
    runs-on: ubuntu-latest
    permissions:
      contents: read
    if: github.repository == 'rsyslog/rsyslog'
    steps:
      - name: Checkout code
        uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
        with:
          persist-credentials: false

      - name: Build documentation in Docker container
        env:
          GOOGLE_ANALYTICS_ID: ${{ secrets.GOOGLE_ANALYTICS_ID }}
          DOC_BASE_URL: ${{ vars.DOC_BASE_URL }}
        run: |
          chmod +x doc/tools/inside_docker_doc_html.sh
          docker run --rm \
            -u "$(id -u):$(id -g)" \
            -e GOOGLE_ANALYTICS_ID \
            -e DOC_BASE_URL \
            -e PYTHONUNBUFFERED=1 \
            -v "$(pwd)":/rsyslog \
            --entrypoint /rsyslog/doc/tools/inside_docker_doc_html.sh \
            rsyslog/rsyslog_dev_doc_base_ubuntu:22.04

      - name: Upload build artifact
        uses: actions/upload-artifact@043fb46d1a93c77aae656e7c1c64a875d1fc6a0a # v7.0.1
        with:
          name: docs-html
          path: doc/build

  deploy:
    needs: build
    runs-on: ubuntu-latest
    if: github.repository == 'rsyslog/rsyslog'
    permissions:
      contents: read
      pages: write
      id-token: write
    environment:
      name: github-pages
      url: ${{ steps.deployment.outputs.page_url }}
    steps:
      - name: Checkout code
        uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
        with:
          persist-credentials: false

      - name: Download built docs artifact
        uses: actions/download-artifact@3e5f45b2cfb9172054b4087a40e8e0b5a5461e7c # v8.0.1
        with:
          name: docs-html
          path: preview-site

      - name: Prepare Pages artifact with /doc/ subdirectory
        env:
          DOC_BASE_URL: ${{ vars.DOC_BASE_URL }}
        run: |
          set -e
          mkdir -p pages-deployment/doc
          rsync -a --delete preview-site/ pages-deployment/doc/
          cp doc/tools/pages-root-index.html pages-deployment/index.html
          # robots.txt: allow only /doc/, sitemap URL from DOC_BASE_URL or github.repository
          REPO="${{ github.repository }}"
          DEFAULT_BASE="https://${REPO%/*}.github.io/${REPO#*/}"
          BASE="${DOC_BASE_URL:-$DEFAULT_BASE}"
          {
            sed '/^# Sitemap/d' doc/tools/pages-robots.txt
            echo "Sitemap: ${BASE}/doc/sitemap.xml"
          } > pages-deployment/robots.txt

      - name: Setup Pages
        uses: actions/configure-pages@45bfe0192ca1faeb007ade9deae92b16b8254a0d # v6.0.0

      - name: Upload to Pages (artifact)
        uses: actions/upload-pages-artifact@fc324d3547104276b827a68afc52ff2a11cc49c9 # v5.0.0
        with:
          path: pages-deployment

      - name: Deploy to GitHub Pages
        id: deployment
        uses: actions/deploy-pages@cd2ce8fcbc39b97be8ca5fce6e763baed58fa128 # v5.0.0