kubevirt.core/.github/workflows/docs.yml

---
name: Documentation
# yamllint disable-line rule:truthy
on:
  push:
    branches:
      - main
    tags:
      - "[0-9]+.[0-9]+.[0-9]+"
  workflow_dispatch:

jobs:
  docs:
    runs-on: ubuntu-latest
    # Do not run in private forks
    if: github.repository == 'kubevirt/kubevirt.core'
    permissions:
      contents: write
    env:
      collection_dir: ansible_collections/kubevirt/core
      work_dir: /home/runner/.ansible/collections
    steps:

      - name: Check out code
        uses: actions/checkout@v7
        with:
          path: ${{ env.collection_dir }}
          fetch-depth: 0

      - name: Set up Python
        uses: actions/setup-python@v6
        with:
          cache: pip

      - name: Install doc dependencies
        run: |
          python -m pip install --upgrade pip setuptools
          pip install \
            -r ${{ env.collection_dir }}/docs/requirements.txt
          pip install \
            -r ${{ env.collection_dir }}/requirements.txt
          mkdir -p ${{ env.work_dir }}
          ansible-galaxy collection install \
            -r ${{ env.collection_dir }}/requirements.yml \
            -p ${{ env.work_dir }} --force-with-deps
          sudo apt install -y sed hub

      - name: Move collection to work dir
        run: |
          cp -rp ansible_collections \
            ${{ env.work_dir }}

      - name: Set up git credentials for gh-pages push
        run: |
          cd ${{ env.collection_dir }}
          git config credential.helper \
            '!f() { echo "username=x-access-token"; echo "password=${GITHUB_TOKEN}"; }; f'
        env:
          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

      - name: Create changelog and documentation
        uses: ansible-middleware/collection-docs-action@main
        with:
          collection_fqcn: kubevirt.core
          collection_repo: kubevirt/kubevirt.core
          dependencies: false
          commit_changelog: false
          commit_ghpages: true
          changelog_release: false
          generate_docs: true
          path: ${{ env.work_dir }}/${{ env.collection_dir }}
          token: ${{ secrets.GITHUB_TOKEN }}
          bot_email: kubevirtbot@redhat.com
          bot_account: kubevirt-bot