chore: build and deploy docc documentation

Author: fortmarek

.github/workflows/deploy.yml

@@ -0,0 +1,28 @@
+on:
+  push:
+    branches:
+      - docs/build-docc
+
+jobs:
+  publish:
+    runs-on: ubuntu-latest
+    permissions:
+      contents: read
+      deployments: write
+    name: Publish to Cloudflare Pages
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+      - uses: jdx/mise-action@v2
+        with:
+          experimental: true
+      - name: Build docs
+        run: mise run docs:build
+      - name: Deploy
+        uses: cloudflare/wrangler-action@v3
+        with:
+          apiToken: ${{ secrets.CLOUDFLARE_API_TOKEN }}
+          accountId: ${{ secrets.CLOUDFLARE_ACCOUNT_ID }}
+          command: pages deploy .build/documentation --project-name=xcodegraph
+          # Optional: Enable this if you want to have GitHub Deployments triggered
+          gitHubToken: ${{ secrets.GITHUB_TOKEN }}

.mise/tasks/docs/build

@@ -0,0 +1,5 @@
+#!/bin/bash
+# mise description="Build docs"
+set -euo pipefail
+
+swift package --package-path $MISE_PROJECT_ROOT --allow-writing-to-directory .build/documentation generate-documentation --disable-indexing --output-path .build/documentation --transform-for-static-hosting --target XcodeGraph

Package.resolved

@@ -9,7 +9,7 @@ let targets: [Target] = [
             "Path",
         ],
         swiftSettings: [
-            .enableExperimentalFeature("StrictConcurrency"),
+            .enableExperimentalFeature("StrictConcurrency")
         ]
     ),
     .target(
@@ -29,7 +29,7 @@ let targets: [Target] = [
         name: "XcodeMetadataTests",
         dependencies: ["XcodeMetadata", "XcodeGraph"],
         swiftSettings: [
-            .enableExperimentalFeature("StrictConcurrency"),
+            .enableExperimentalFeature("StrictConcurrency")
         ]
     ),
     .target(
@@ -42,14 +42,14 @@ let targets: [Target] = [
             .product(name: "XcodeProj", package: "XcodeProj"),
         ],
         swiftSettings: [
-            .enableExperimentalFeature("StrictConcurrency"),
+            .enableExperimentalFeature("StrictConcurrency")
         ]
     ),
     .testTarget(
         name: "XcodeGraphTests",
         dependencies: [.target(name: "XcodeGraph")],
         swiftSettings: [
-            .enableExperimentalFeature("StrictConcurrency"),
+            .enableExperimentalFeature("StrictConcurrency")
         ]
     ),
     .testTarget(
@@ -59,7 +59,7 @@ let targets: [Target] = [
             .product(name: "FileSystem", package: "FileSystem"),
         ],
         swiftSettings: [
-            .enableExperimentalFeature("StrictConcurrency"),
+            .enableExperimentalFeature("StrictConcurrency")
         ]
     ),
 ]
@@ -83,6 +83,7 @@ let package = Package(
         .package(url: "https://github.com/apple/swift-service-context", .upToNextMajor(from: "1.0.0")),
         .package(url: "https://github.com/Kolos65/Mockable.git", .upToNextMajor(from: "0.0.11")),
         .package(url: "https://github.com/p-x9/MachOKit", .upToNextMajor(from: "0.28.0")),
+        .package(url: "https://github.com/swiftlang/swift-docc-plugin", from: "1.0.0"),
     ],
     targets: targets
 )