DiffableUI/.github/workflows/deploy-docs.yml at 02bbd696262bdcf845e262645beb4e72dfe93c54 · loloop/DiffableUI · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
name: Deploy Documentation

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

# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
permissions:
  contents: read
  pages: write
  id-token: write

# Allow only one concurrent deployment, skipping runs queued between the run in-progress and latest queued.
concurrency:
  group: "pages"
  cancel-in-progress: false

jobs:
  build:
    runs-on: macos-latest

    steps:
    - name: Checkout
      uses: actions/checkout@v4

    - name: Setup Xcode
      uses: maxim-lobanov/setup-xcode@v1
      with:
        xcode-version: latest-stable

    - name: Build Documentation
      run: |
        xcodebuild docbuild \
          -scheme DiffableUI \
          -derivedDataPath .build \
          -destination 'platform=iOS Simulator,name=iPhone 16'

    - name: Process Documentation Archive
      run: |
        DOCC_PATH="$(xcode-select -p)/usr/bin/docc"
        "$DOCC_PATH" process-archive \
          transform-for-static-hosting .build/Build/Products/Debug/DiffableUI.doccarchive \
          --hosting-base-path /DiffableUI \
          --output-path docs-website

    - name: Create index redirect
      run: |
        cat > docs-website/index.html << 'EOF'
        <!DOCTYPE html>
        <html>
        <head>
            <meta charset="utf-8">
            <meta http-equiv="refresh" content="0; url=./documentation/diffableui/">
            <title>DiffableUI Documentation</title>
        </head>
        <body>
            <p>Redirecting to <a href="./documentation/diffableui/">DiffableUI Documentation</a>...</p>
        </body>
        </html>
        EOF

    - name: Upload artifact
      uses: actions/upload-pages-artifact@v3
      with:
        path: ./docs-website

  deploy:
    needs: build
    runs-on: ubuntu-latest
    if: github.event_name == 'push' && github.ref == 'refs/heads/main'

    environment:
      name: github-pages
      url: ${{ steps.deployment.outputs.page_url }}

    steps:
    - name: Deploy to GitHub Pages
      id: deployment
      uses: actions/deploy-pages@v4