documentation.yml

name: Documentation

on:
  push:
    branches: ["main"]
    paths:
      - "Sources/**/*.swift"
      - "Tests/**/*.swift"
      - "**/*.md"

# Allow one concurrent deployment
concurrency:
  group: "pages"
  cancel-in-progress: true

jobs:
  deploy-pages:
    name: Deploy Documentation to GitHub Pages
    runs-on: macos-14
    environment:
      name: github-pages
      url: ${{ steps.deployment.outputs.page_url }}
    permissions:
      pages: write # to deploy to Pages
      id-token: write # to verify the deployment originates from an appropriate source
    steps:
      - name: Configure Xcode
        uses: maxim-lobanov/setup-xcode@v1
        with:
          xcode-version: latest-stable
      - name: Checkout Code
        uses: actions/checkout@v4
      - name: Cache SPM dependencies
        uses: actions/cache@v4
        with:
          path: .build
          key: ${{ runner.os }}-spm-${{ hashFiles('**/Package.resolved') }}
          restore-keys: |
            ${{ runner.os }}-spm-
      - name: Build DocC
        run: Scripts/build-docc-archive HPOpenWeather
      - name: Upload artifact
        uses: actions/upload-pages-artifact@v3
        with:
          path: ${{ runner.temp }}/docs
      - name: Deploy to GitHub Pages
        id: deployment
        uses: actions/deploy-pages@v4