Track the public API surface in CI
维护者通常 1 天内回复
还没有人认领这个 Issue。
评估
- 难度
- 4/5
- 预计耗时
- 3-5 天
- 新手友好度
- 57/100
- Issue 类型
- 功能
- 描述清晰度
- 描述清楚
- 活跃度
- 活跃
- 技术栈
- github-actions, node.js, typescript
- 领域
- api, build-system, ci-cd
调研方向
Read .github/workflows/checks.yml, the root package.json scripts near knip, and the exports in packages/testcontainers/src/index.ts; review API Extractor’s report and CI setup. Check the status of blocking issue #1528 and coordinate the initial report timing with #1529 before implementing. Done when CI checks a committed API report, flags unexported types in public signatures, and requires the major label for removed or changed exports.
由索引模型根据 Issue 内容生成。
描述
What happens
The public API is whatever packages/testcontainers/src/index.ts exports, plus every type reachable from those exports. Nothing shows a reviewer when a pull request changes it.
- Types used in public signatures went unexported.
- The
TestContainerinterface fell behindGenericContainer. - Whether a change is breaking is judged by hand, and the semver label is applied by hand.
Expected
A generated API report checked in CI, for example with API Extractor:
- The report is committed. A pull request that changes the public API changes the report, and the diff is visible in review.
- An exported signature that references an unexported type fails the check.
- A removed or changed export requires the
majorlabel.
Where
.github/workflows/checks.yml- root
package.jsonscripts, next toknip packages/testcontainers, and optionally each module
Notes
npm run knipcovers unused exports. This covers the opposite problem.- A committed report is touched by every API change, so it conflicts when many API pull requests are open at once. Regenerating on rebase resolves it.
Dependencies
- Blocked by #1528: the unexported-type check fails until those types are exported.
- Coordinate with #1529: the first report should be taken after the interface is complete.
- 主要语言
- TypeScript
- 星标
- 2.6k
- 派生
- 274
- 平均合并
- 1 天 14 小时
- 30 天内合并 PR
- 44
环境准备
在浏览器里用你自己的 GitHub 账号启动这个项目的开发容器。
- 提供 Dockerfile 或 Docker Compose 文件
- 没有 Pull Request 模板
- 阅读贡献指南
从这里开始
- 先读完整个 Issue，再读项目的贡献指南。
- 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
- Fork 仓库，在一个分支上完成修改。
- 提交 Pull Request，并在描述里引用这个 Issue 编号。
testcontainers/testcontainers-node 的其他 Issue
-
enhancement minor
难度 2/5 1-3 小时 新手友好度 74/100
testcontainers/testcontainers-node#1539 ·
维护者通常 1 天内回复
-
enhancement minor
难度 2/5 1-3 小时 新手友好度 82/100
testcontainers/testcontainers-node#1533 ·
维护者通常 1 天内回复
-
enhancement minor
难度 2/5 1-3 小时 新手友好度 77/100
testcontainers/testcontainers-node#1531 ·
维护者通常 1 天内回复
-
enhancement minor
难度 2/5 1-3 小时 新手友好度 76/100
testcontainers/testcontainers-node#1529 ·
维护者通常 1 天内回复
-
enhancement minor
难度 2/5 1-3 小时 新手友好度 78/100
testcontainers/testcontainers-node#1528 ·
维护者通常 1 天内回复
查看 testcontainers/testcontainers-node 的全部 Issue
相似的 Issue
-
难度 2/5 1-3 小时 新手友好度 72/100
wormhole-foundation/wormhole#5062 ·
维护者通常 1 天内回复
-
internal os specific
难度 2/5 1-3 小时 新手友好度 65/100
frostney/GocciaScript#1688 ·
维护者通常 1 天内回复
-
integration:hermes
难度 2/5 1-3 小时 新手友好度 70/100
vectorize-io/hindsight#5592 ·
维护者通常 1 天内回复
-
bug
难度 2/5 1-3 小时 新手友好度 72/100
vercel/streamdown#673 · 1 个 reaction ·
维护者通常 1 天内回复
-
难度 2/5 1-3 小时 新手友好度 74/100
apache/rocketmq-dashboard#6712 ·
维护者通常 3 天内回复