create-doc.yaml

# A reusable workflow for
# anything that needs to create the
# documentation pages.
# This will accept some input arguments
# and will upload an artifact that contains
# the html directory.
name: "Build doc and upload build/html as tar.gz"

on:
  workflow_call:
    inputs:
      name:
        required: true
        type: string
      targz_name:
        required: true
        type: string

jobs:

  # The actual job of the build-script
  build-documentation:

    name: Build documentation
    runs-on: ubuntu-latest

    steps:
    - name: Checkout sources
      uses: actions/checkout@v4
      with:
        submodules: false

    - name: Python installation
      uses: actions/setup-python@v5
      with:
        python-version: "3.12"

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

    - name: Restore cached gifs
      uses: actions/cache@v4
      id: cache-gif
      with:
        key: gifs-${{ hashFiles('docs/os/gifs/**/*.yml') }}
        path: |
          docs/os/gifs/*/*.gif

    - name: Node.js setup
      if: ${{ steps.cache-gif.outputs.cache-hit != 'true' }}
      uses: actions/setup-node@v4
    
    - name: Run gifs
      if: ${{ steps.cache-gif.outputs.cache-hit != 'true' }}
      run: |
        sudo apt-get install xvfb
        npm install -g terminalizer
        cd docs/os/gifs
        xvfb-run --auto-servernum bash create.sh || echo "Forced succeed $?"
        echo pwd=$(pwd)
        exit 0

    - name: Build and tar.gz documentation
      run: |
        make all
        # tar gz the build/html dir
        tar -czf ${{ inputs.targz_name }} -C build/html .

    - name: Upload artifact
      uses: actions/upload-artifact@v4
      with:
        name: ${{ inputs.name }}
        path: ${{ inputs.targz_name }}
        retention-days: 3