SuperAPI AI 工具集

swift-docc-github-pages

部署与运维

查看项目

更新于 10-16 06:19

技能介绍

用途:把 Swift 包的 DocC 文档自动构建并发布到 GitHub Pages。

构建方式选择:若 Package.swift 仅支持 iOS,使用 xcodebuild docbuild;若包含 macOS,则使用 swift-docc-plugin。原因是 swift package generate-documentation 面向 macOS 构建,仅 iOS 的包会报“no such module 'UIKit'”。

主要能力与用法:创建 .github/workflows/docc.yml,替换 TARGET_NAME、TARGET_NAME_LOWERCASE、REPO_NAME。仅 iOS 的工作流使用 xcodebuild docbuild 生成 .doccarchive,再用 docc process-archive transform-for-static-hosting 转为静态托管,并通过上传产物与 deploy-pages 部署。跨平台方案在 Package.swift 添加 swift-docc-plugin 依赖,改用 swift package generate-documentation 并设置 --hosting-base-path。

要点:在 Settings → Pages 把 Source 设为 GitHub Actions;文档 URL 为 https://USER.github.io/REPO/documentation/targetnamelowercase/,目标名一律小写;根路径 404 需添加重定向 index.html;文档为空需确保类型为 public。

本地测试:分别用上述 xcodebuild 或 swift package 命令生成 ./docs。可选用 Documentation.docc 自定义文档,或添加 .spi.yml 交由 Swift Package Index 托管。

限制:资料未提供除 GitHub Actions 外的部署方式、收费信息或具体版本兼容范围。