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

Versioning of packages doesn't follow the semantic versioning specification

Đang mở
  • Có gì không ổn?
#166 3 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 2 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
30/100
Loại issue
Lỗi
Độ rõ ràng
Khá rõ ràng
Mức độ hoạt động
Đình trệ
Công nghệ
typescript
Lĩnh vực
api, release

Hướng nghiên cứu

Start by reviewing the @redhat-cloud-services/host-inventory-client package versioning and the linked commit that changed HostsApi.apiHostGetHostList parameter order. Compare the published version changes with the interface break, then trace the repository's package release configuration. Done means breaking client changes are identified, documented, and released with a major-version increment rather than only a patch increment.

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

Mô tả

Hello, I recently worked with one of the API client - @redhat-cloud-services/host-inventory-client and the Inventory application (which is a consumer of this client). While I was upgrading the client dependency version from 1.0.96 to 1.0.109, I found out that the application has got broken. Debugging the problem, I realized that the HostsApi's apiHostGetHostList function parameters were modified (specifically, the order has changed, and the wrong parameters were sent by the consumer app).

I managed to fix this and this is OK to have client interface changes, however, I would love to see such breaking changes documented and reflected with the help of versioning of the package. Just incrementing the patch version is not correct, because I would expect the increment of the major version if a broken change introduced to the interface.

Just for evidence and illustration, this is the commit that changed the function parameters: https://github.com/RedHatInsights/javascript-clients/commit/b9b68398ca1f7e5b4176cd0e064e81af8c8cf01a#diff-a9f2cff91e34cf8e2a01709fba111c82cc0e22f1f5f3782607c7f789beb189aeR1907.

Ngôn ngữ chính
TypeScript
Star
7
Fork
37
Merge trung bình
2 ngày 2 giờ
Pull request đã merge (30 ngày)
43

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

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 RedHatInsights/javascript-clients

Tất cả issue của RedHatInsights/javascript-clients

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.