documentation.yml

name: Documentation

on:
  push:
    branches: [master]
  pull_request:
    branches: [master]
  workflow_dispatch:

permissions:
  contents: read

concurrency:
  group: documentation-${{ github.ref }}
  cancel-in-progress: true

jobs:
  build:
    name: Build user guide and API reference
    runs-on: ubuntu-24.04
    steps:
      - name: Check out sources
        uses: actions/checkout@v7

      - name: Build existing Jekyll user guide
        uses: actions/jekyll-build-pages@v1
        with:
          source: ./
          destination: ./_site
          baseurl: /${{ github.event.repository.name }}

      - name: Install documentation tools
        run: |
          sudo apt-get update
          sudo apt-get install --yes doxygen graphviz

      - name: Build API reference
        run: |
          bash doc/build-api.sh "$RUNNER_TEMP/intarna-api"
          # The Jekyll container creates its output as root.
          sudo chown -R "$(id -u):$(id -g)" _site
          cp -R "$RUNNER_TEMP/intarna-api/html" _site/api

      - name: Check generated documentation
        run: |
          python3 doc/check-api.py _site/api
          test -s _site/index.html
          test -s _site/doc/figures/icon-up.28.png

      - name: Upload documentation for review and deployment
        uses: actions/upload-pages-artifact@v4
        with:
          path: _site
          retention-days: 7

  deploy:
    name: Publish documentation
    if: github.repository == 'BackofenLab/IntaRNA' && github.ref == 'refs/heads/master' && github.event_name != 'pull_request'
    needs: build
    runs-on: ubuntu-24.04
    permissions:
      pages: write
      id-token: write
    environment:
      name: github-pages
      url: ${{ steps.deployment.outputs.page_url }}
    steps:
      - name: Deploy GitHub Pages
        id: deployment
        uses: actions/deploy-pages@v4