documentation.yml

name: Documentation

on:
  pull_request:
    branches:
      - main
  push:
    branches:
      - main
    paths:
      - ".github/workflows/documentation.yml"
      - "**/*.swift"
      - "**/*.docc/**/*.md"
  workflow_dispatch:

permissions:
  contents: read
  pages: write
  id-token: write

concurrency:
  group: "deploy-documentation"
  cancel-in-progress: true

jobs:
  build:
    name: Build
    runs-on: ubuntu-latest
    container: swift:6.0-jammy
    steps:
      - name: Checkout
        uses: actions/checkout@v4

      - name: Setup Pages
        uses: actions/configure-pages@v5
      
      - name: Build documentation
        run: |
          swift package \
          --allow-writing-to-directory docs \
          generate-documentation \
          --target TMDb \
          --disable-indexing \
          --transform-for-static-hosting \
          --hosting-base-path TMDb \
          --output-path docs \
          --warnings-as-errors
        env:
          SWIFTCI_DOCC: 1

      - name: Upload documentation
        if: github.ref == 'refs/heads/main'
        uses: actions/upload-pages-artifact@v3
        with:
          path: 'docs'
  
  deploy:
    name: Deploy
    if: github.ref == 'refs/heads/main'
    runs-on: ubuntu-latest
    needs: build
    environment:
      name: github-pages
      url: ${{ steps.deployment.outputs.page_url }}documentation/tmdb
    steps:
      - name: Deploy to GitHub Pages
        id: deployment
        uses: actions/deploy-pages@v4