deploy-github-pages.yml

# Copyright 2024 Remy Blank <remy@c-space.org>
# SPDX-License-Identifier: MIT

name: Publish to GitHub Pages
on:
  workflow_call:
    inputs:
      dev:
        description: "When true, use t-doc/common at head for building."
        type: boolean
        required: false

jobs:
  publish:
    name: Publish to GitHub pages
    environment:
      name: github-pages
      url: ${{ steps.deployment.outputs.page_url }}
    runs-on: ubuntu-latest
    concurrency:
      group: pages
      cancel-in-progress: false
    permissions:
      contents: read
      pages: write
      id-token: write
    steps:
      - name: Update system package index
        run: sudo apt-get update
      - name: Install system packages
        run: |
          sudo apt-get install --yes \
              graphviz
      - name: Install Python
        id: python
        uses: actions/setup-python@v5
        with:
          python-version: '3.12'
      - name: Checkout t-doc/common repository
        if: ${{ inputs.dev }}
        uses: actions/checkout@v4
        with:
          repository: t-doc-org/common
          ref: main
          submodules: recursive
          path: common
          ssh-key: ${{ secrets.DEPLOY_COMMON }}
      - name: Install t-doc/common package from checkout
        if: ${{ inputs.dev }}
        run: |
          ${{ steps.python.outputs.python-path }} -m pip install ./common
      - name: Install t-doc/common package from PyPI
        if: ${{ !inputs.dev }}
        run: |
          ${{ steps.python.outputs.python-path }} -m pip install t-doc-common
      - name: Checkout repository
        uses: actions/checkout@v4
        with:
          path: repo
      - name: Build HTML
        run: |
          tdoc --source=repo/docs --build=_build build html
      - name: Configure GitHub Pages
        uses: actions/configure-pages@v5
      - name: Upload GitHub Pages artifact
        uses: actions/upload-pages-artifact@v3
        with:
          path: _build/html
      - name: Deploy to GitHub Pages
        id: deployment
        uses: actions/deploy-pages@v4