Add an API diff workflow
还没有人认领这个 Issue。
评估
- 难度
- 4/5
- 预计耗时
- 3-5 天
- 新手友好度
- 45/100
调研方向
首先阅读现有的 API breakage workflow，并跟踪它如何在 pull request 上运行。确定如何获取 swiftinterface diff，或为不使用 library evolution 的 package 获取等效内容，并比较将其作为 PR 评论呈现与作为 GitHub check 输出呈现的方式。完成标准是 workflow 能够展示 API diff，并支持配置要包含哪些 module。
由索引模型根据 Issue 内容生成。
描述
In addition to the existing API breakage workflow, it'd be helpful to see the diff of the swiftinterface file (or equivalent for packages that can't build with library evolution enabled) that the PR is making.
When a package has a large diff where most of the code is implementation, it can be difficult to spot the exact API changes it's making.
There are a few ways this could be surfaced to the user:
- Option A: A comment posted by the workflow back on the PR
- Option B: The workflow just printing the diff and the user needing to click on the GitHub check link and reviewing it manually
Either would be fine to start.
Presumably, this would come with some configurability, mainly the list of modules to diff - there might be internal modules that the maintainer might not care about seeing the diff of, and might even cause noise.
- 主要语言
- Swift
- 星标
- 115
- 派生
- 57
- 平均合并
- 2 天 11 小时
- 30 天内合并 PR
- 2
环境准备
- 没有 Dockerfile 或 Docker Compose 文件
- 没有 Pull Request 模板
- 阅读贡献指南
从这里开始
- 先读完整个 Issue，再读项目的贡献指南。
- 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
- Fork 仓库，在一个分支上完成修改。
- 提交 Pull Request，并在描述里引用这个 Issue 编号。
swiftlang/github-workflows 的其他 Issue
-
难度 2/5 1-3 小时 新手友好度 72/100
swiftlang/github-workflows#305 ·
-
难度 2/5 1-3 小时 新手友好度 78/100
swiftlang/github-workflows#261 ·
-
难度 2/5 1-3 小时 新手友好度 72/100
swiftlang/github-workflows#258 · 1 条评论 ·
-
难度 3/5 1-2 天 新手友好度 68/100
swiftlang/github-workflows#312 ·
-
难度 3/5 1-2 天 新手友好度 58/100
swiftlang/github-workflows#277 · 1 条评论 ·
查看 swiftlang/github-workflows 的全部 Issue
相似的 Issue
-
clawsweeper:linked-pr-open clawsweeper:no-new-fix-pr clawsweeper:source-repro impact:ux-friction issue-rating: 🦞 diamond lobster P2
难度 2/5 1-3 小时 新手友好度 86/100
steipete/RepoBar#140 · 1 条评论 · 1 个 reaction ·
维护者通常 1 天内回复
-
area:dictation bug P2
难度 2/5 1-3 小时 新手友好度 88/100
uttrflow/uttrflow-swift#2551 ·
维护者通常 1 天内回复
-
bot:candidate
难度 1/5 1 小时以内 新手友好度 95/100
imbhargav5/open-recorder#1275 ·
维护者通常 1 天内回复
-
bug
难度 2/5 1-3 小时 新手友好度 84/100
EtanHey/brainlayer#984 ·
维护者通常 1 天内回复
-
难度 2/5 1-3 小时 新手友好度 68/100
维护者通常 1 天内回复