XcodeMCPWrapper/.github/workflows/docs.yml at main · SoundBlaster/XcodeMCPWrapper · 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
83
84
85
86
87
88
89
90
name: Deploy DocC Documentation

on:
  push:
    branches:
      - main
    paths:
      - '**.swift'
      - '**.md'
      - 'Sources/XcodeMCPWrapper/Documentation.docc/**'
      - '.github/workflows/docs.yml'
  pull_request:
    branches:
      - main
  workflow_dispatch: # Allow manual trigger

# 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-14

    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: |
          swift package --allow-writing-to-directory ./.docc-build \
            generate-documentation \
            --target XcodeMCPWrapper \
            --output-path ./.docc-build \
            --transform-for-static-hosting \
            --hosting-base-path XcodeMCPWrapper

      - name: Add .nojekyll and index.html redirect
        run: |
          touch .docc-build/.nojekyll
          cat > .docc-build/index.html << 'EOF'
          <!DOCTYPE html>
          <html>
          <head>
            <meta charset="utf-8">
            <title>Redirecting to XcodeMCPWrapper Documentation</title>
            <meta http-equiv="refresh" content="0; url=./documentation/xcodemcpwrapper/">
            <link rel="canonical" href="./documentation/xcodemcpwrapper/">
          </head>
          <body>
            <p>Redirecting to <a href="./documentation/xcodemcpwrapper/">XcodeMCPWrapper Documentation</a>...</p>
            <script>
              window.location.href = "./documentation/xcodemcpwrapper/";
            </script>
          </body>
          </html>
          EOF

      - name: Upload artifact
        if: github.event_name == 'push'
        uses: actions/upload-pages-artifact@v3
        with:
          path: "./.docc-build"

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

    # Deploy to the github-pages environment
    environment:
      name: github-pages
      url: ${{ steps.deployment.outputs.page_url }}

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