Hacktoberfest 2026: những issue maintainer đã đánh dấu cho tháng Mười, đang mở và phù hợp người mới. Xem issue Hacktoberfest

Track the public API surface in CI

Đang mở
  • Có gì không ổn?
#1,580 0 bình luận 0 reaction 0 người được giao Xem trên GitHub

Maintainer thường phản hồi trong vòng 1 ngày

Chưa có ai nhận issue này.

Đánh giá

Độ khó
4/5
Thời gian dự kiến
3-5 ngày
Mức phù hợp với người mới
57/100
Loại issue
Tính năng
Độ rõ ràng
Đặc tả rõ ràng
Mức độ hoạt động
Sôi nổi
Công nghệ
github-actions, node.js, typescript
Lĩnh vực
api, build-system, ci-cd

Hướng nghiên cứu

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.

Do mô hình lập chỉ mục viết ra từ nội dung của issue.

Mô tả

maintenance patch

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 TestContainer interface fell behind GenericContainer.
  • 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 major label.

Where

  • .github/workflows/checks.yml
  • root package.json scripts, next to knip
  • packages/testcontainers, and optionally each module

Notes

  • npm run knip covers 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.
Ngôn ngữ chính
TypeScript
Star
2.6k
Fork
274
Merge trung bình
1 ngày 14 giờ
Pull request đã merge (30 ngày)
44

Chuẩn bị môi trường

Mở trong Codespaces

Khởi chạy dev container của dự án ngay trên trình duyệt, bằng tài khoản GitHub của bạn.

Bắt đầu từ đâu

  1. Đọc hết issue, rồi đọc hướng dẫn đóng góp của dự án.
  2. Bình luận trên issue rằng bạn sẽ nhận — tránh hai người làm cùng một việc.
  3. Fork repository và làm thay đổi trên một nhánh.
  4. Mở pull request có tham chiếu số hiệu của issue.

Issue khác của testcontainers/testcontainers-node

Tất cả issue của testcontainers/testcontainers-node

Issue tương tự

Thêm issue về TypeScript

Nhận issue mới trong hộp thư của bạn

Bản tóm tắt ngắn những issue GitHub phù hợp với người mới.