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

Add an API diff workflow

Đang mở
#155 2 bình luận 2 reaction 0 người được giao Xem trên GitHub

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
45/100
Loại issue
Tính năng
Độ rõ ràng
Khá rõ ràng
Mức độ hoạt động
Ít trao đổi
Công nghệ
github-actions, swift
Lĩnh vực
api, ci-cd

Hướng nghiên cứu

Bắt đầu bằng cách đọc workflow hiện có cho API breakage và theo dõi cách workflow chạy trên các pull request. Xác định cách lấy diff của swiftinterface, hoặc một giải pháp tương đương cho các package không có library evolution, rồi so sánh việc trình bày diff này dưới dạng bình luận PR với việc đưa nó vào đầu ra của GitHub check. Được xem là hoàn thành khi workflow hiển thị diff API và hỗ trợ cấu hình các module được bao gồm.

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

Mô tả

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.

Ngôn ngữ chính
Swift
Star
115
Fork
57
Merge trung bình
1 ngày 8 giờ
Pull request đã merge (30 ngày)
3

Hướng dẫn đóng góp

Mở hướng dẫn đóng góp

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 swiftlang/github-workflows

Tất cả issue của swiftlang/github-workflows

Issue tương tự

Thêm issue về Swift

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.