feat: rename XcodeProjMapper to XcodeGraphMapper (#103)

* chore: build and deploy docc documentation

* Enable combined documentation

* Skip building XcodeMetadata

* Use development toolchain

* Update Mockable

* Revert back to the latest version

* Add build docs workflow

* Rename XcodeProjMapper to XcodeGraphMapper

* Lint code

Author: fortmarek

.github/workflows/XcodeGraph.yml

@@ -2,7 +2,7 @@ name: XcodeGraph
 on:
   push:
     branches:
-      - "**"
+      - "main"
     tags-ignore:
       - "**"
     paths:
@@ -51,7 +51,7 @@ jobs:
       - name: Test on Linux
         if: matrix.os == 'ubuntu-22.04'
         # These momdules rely on some Xcode utilities like xcode-select
-        run: swift test --skip XcodeProjMapperTests --skip XcodeMetadataTests
+        run: swift test --skip XcodeGraphMapperTests --skip XcodeMetadataTests
       - name: Test
         if: matrix.os != 'ubuntu-22.04'
         run: swift test

.github/workflows/deploy.yml

@@ -0,0 +1,31 @@
+on:
+  push:
+    branches:
+      - main
+
+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: Setup Swift
+        uses: SwiftyLab/setup-swift@latest
+        with:
+          swift-version: 6.0.3
+      - 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
+          gitHubToken: ${{ secrets.GITHUB_TOKEN }}

.github/workflows/docs.yml

@@ -0,0 +1,29 @@
+name: Docs
+
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+  merge_group:
+
+concurrency:
+  group: docs-${{ github.head_ref }}
+  cancel-in-progress: true
+
+jobs:
+  build:
+    name: Build
+    runs-on: "ubuntu-latest"
+    timeout-minutes: 15
+    steps:
+      - uses: actions/checkout@v4
+      - uses: jdx/mise-action@v2
+        with:
+          experimental: true
+      - name: Setup Swift
+        uses: SwiftyLab/setup-swift@latest
+        with:
+          swift-version: 6.0.3
+      - name: Build docs
+        run: mise run docs:build

.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 --enable-experimental-combined-documentation --target XcodeGraph --target XcodeGraphMapper

CHANGELOG.md

@@ -33,7 +33,7 @@ let targets: [Target] = [
         ]
     ),
     .target(
-        name: "XcodeProjMapper",
+        name: "XcodeGraphMapper",
         dependencies: [
             "XcodeGraph",
             "XcodeMetadata",
@@ -53,9 +53,9 @@ let targets: [Target] = [
         ]
     ),
     .testTarget(
-        name: "XcodeProjMapperTests",
+        name: "XcodeGraphMapperTests",
         dependencies: [
-            "XcodeProjMapper",
+            "XcodeGraphMapper",
             .product(name: "FileSystem", package: "FileSystem"),
         ],
         swiftSettings: [
@@ -72,7 +72,7 @@ let package = Package(
             name: "XcodeGraph",
             targets: ["XcodeGraph"]
         ),
-        .library(name: "XcodeProjMapper", targets: ["XcodeProjMapper"]),
+        .library(name: "XcodeGraphMapper", targets: ["XcodeGraphMapper"]),
     ],
     dependencies: [
         .package(url: "https://github.com/Flight-School/AnyCodable", .upToNextMajor(from: "0.6.7")),
@@ -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
 )