docs.yml

# WARNING: DO NOT EDIT!
#
# This file was generated by plugin_template, and is managed by it. Please use
# './plugin-template --github pulp_ostree' to update this file.
#
# For more info visit https://github.com/pulp/plugin_template

---
name: "Docs"
on:
  workflow_call:

jobs:
  test:
    if: "endsWith(github.base_ref, 'main')"
    runs-on: "ubuntu-20.04"
    defaults:
      run:
        working-directory: "pulp_ostree"
    steps:
      - uses: "actions/checkout@v4"
        with:
          fetch-depth: 1
          path: "pulp_ostree"
      - uses: "actions/setup-python@v5"
        with:
          python-version: "3.11"
      - name: "Setup cache key"
        run: |
          git ls-remote https://github.com/pulp/pulp-docs main | tee pulp-docs-main-sha
      - uses: "actions/cache@v4"
        with:
          path: "~/.cache/pip"
          key: ${{ runner.os }}-pip-${{ hashFiles('pulp-docs-main-sha') }}
          restore-keys: |
            ${{ runner.os }}-pip-
      - name: "Install python dependencies"
        run: |
          echo ::group::PYDEPS
          pip install -r doc_requirements.txt
          echo ::endgroup::
      - name: "Build changelog"
        run: |
          towncrier build --yes --version 4.0.0.ci
      - name: "Build docs"
        run: |
          pulp-docs build

  no-test:
    if: "!endsWith(github.base_ref, 'main')"
    runs-on: "ubuntu-20.04"
    steps:
      - run: |
          echo "Skip docs testing on non-main branches."