tools-api-docs-release.yml

name: nf-core/tools release API docs
on:
  release:
    types: [published]

# Cancel if a newer run is started
concurrency:
  group: ${{ github.workflow }}-${{ github.event.pull_request.number || github.ref }}
  cancel-in-progress: true

jobs:
  api-docs:
    name: Build & push Sphinx API docs
    runs-on: ubuntu-latest
    strategy:
      matrix:
        dir:
          - latest
          - ${{ github.event.release.tag_name }}
    steps:
      - name: Check out source-code repository
        uses: actions/checkout@v3

      - name: Set up Python 3.11
        uses: actions/setup-python@v4
        with:
          python-version: 3.11

      - name: Install python dependencies
        run: |
          pip install --upgrade pip
          pip install -r ./docs/api/requirements.txt
          pip install .

      - name: Build HTML docs
        run: make --directory ./docs/api html

      - name: Sync release docs
        if: github.repository == 'nf-core/tools'
        uses: SamKirkland/FTP-Deploy-Action@4.0.0
        with:
          server: ${{ secrets.ftp_server }}
          username: ${{ secrets.ftp_username}}
          password: ${{ secrets.ftp_password }}
          local-dir: "./docs/api/_build/html/"
          server-dir: ${{ secrets.ftp_server_old_site_dir }}/${{ matrix.dir }}/
          protocol: ${{ secrets.ftp_protocol }}
          port: ${{ secrets.ftp_port }}