Docs soundness check fails in the vicinity of platform-specific API

未关闭

#166 创建于 2025年9月23日 0 条评论 0 个 reaction 已指派 0 人在 GitHub 查看

还没有人认领这个 Issue。

评估

难度: 5/5
预计耗时: 一周以上
新手友好度: 25/100

Issue 类型: 功能
描述清晰度: 需要澄清
活跃度: 停滞
技术栈: swift
领域: ci-cd, documentation

调研方向

从 issue 中描述的 Linux DocC bundle 构建和 soundness 检查开始，重点关注 Linux 上标记为 @available(unavailable) 的符号引用。比较该检查如何处理所提及的 package 和 target 变体之间的平台特定 API，并考虑 issue 中列出的可能方案。当该检查不再对有效的平台特定文档错误失败时，即视为完成。

由索引模型根据 Issue 内容生成。

描述

The docs soundness check runs on Linux currently. Swift Testing has some Apple-specific API (and some Windows-specific API) and our DocC bundle contains some references to symbols that are marked @available(unavailable) on Linux. As a result, when we build our DocC bundle on Linux, those symbols are called out as missing. When we run the soundness check, it fails outright.

We need some general way to solve this problem for packages/targets/etc. that have platform-specific API variation. I'm not sure what a good solution looks like here. I don't know if that means making a change in swift-docc to introduce something like #if, or if it means having the soundness check run for multiple targets and combine results, or set a Swift compiler condition during the build that we can use to "opt out" some code from the check, or…

This problem isn't specific to Swift Testing: swift-system and swift-subprocess are also impacted, for example.

主要语言: Swift
星标: 115
派生: 57
平均合并: 1 天 8 小时
30 天内合并 PR: 3

贡献指南

打开贡献指南

从这里开始

先读完整个 Issue，再读项目的贡献指南。
在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
Fork 仓库，在一个分支上完成修改。
提交 Pull Request，并在描述里引用这个 Issue 编号。

swiftlang/github-workflows 的其他 Issue

Please skip CI jobs that run on self-hosted runners on forked repositories 未关闭

难度 2/5 1-3 小时新手友好度 72/100

swiftlang/github-workflows#305 · 2026年7月21日创建
License header check needs to account for shebangs other than #!/bin/bash 未关闭

难度 2/5 1-3 小时新手友好度 78/100

swiftlang/github-workflows#261 · 2026年4月10日创建
Update from actions/checkout@v4 to v6 未关闭

难度 2/5 1-3 小时新手友好度 72/100

swiftlang/github-workflows#258 · 1 条评论 · 2026年4月7日创建
macOS Testing is broken with nightly toolchain 未关闭

难度 3/5 1-2 天新手友好度 68/100

swiftlang/github-workflows#312 · 2026年8月21日创建
Android testing is broken with swiftbuild 未关闭

难度 3/5 1-2 天新手友好度 58/100

swiftlang/github-workflows#277 · 1 条评论 · 2026年6月3日创建

查看 swiftlang/github-workflows 的全部 Issue

相似的 Issue

Remove `--disable-sandbox` workaround from the CodeQL workflow 未关闭

task

难度 2/5 1-3 小时新手友好度 70/100

vsanthanam/JBird#429 · 2026年9月24日创建
Bolus validation button text 未关闭

needs-triage

难度 2/5 1-3 小时新手友好度 75/100

nightscout/Trio#1574 · 2026年9月24日创建
Pod install throws [ArgumentError] Unable to find compatibility version string for object version `110` for projects built by Xcode 27.0 未关闭

难度 2/5 1-3 小时新手友好度 75/100

CocoaPods/CocoaPods#12927 · 2026年9月24日创建
Import of FaceLiveness not enough to use FaceLivenessDetectorView 未关闭

pending-maintainer-response pending-triage

难度 2/5 1-3 小时新手友好度 75/100

aws-amplify/amplify-ui-swift-liveness#252 · 2026年9月24日创建
make notarise-dmg notarises whichever dist/ image sorts last, not the one make dmg just built 未关闭

area:build bug good first issue P2

难度 2/5 1-3 小时新手友好度 75/100

uttrflow/uttrflow-swift#1412 · 2026年9月24日创建

更多 Swift Issue