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

ci: docs routing skips the BReg facility OpenAPI source

Đang mở Phù hợp với người mới
#2,162 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ó
2/5
Thời gian dự kiến
1-3 giờ
Mức phù hợp với người mới
90/100
Loại issue
Lỗi
Độ rõ ràng
Đặc tả rõ ràng
Mức độ hoạt động
Sôi nổi
Công nghệ
javascript, openapi, python
Lĩnh vực
ci-cd, documentation, testing

Hướng nghiên cứu

Bắt đầu với .github/scripts/ci_changes.py và đường dẫn products/breg/generated/facility/generated/openapi.json hiện đang bị bỏ qua. Cập nhật các mẫu nguồn tài liệu, sau đó điều chỉnh kiểm thử độ phủ để liệt kê mọi mục trong SPEC_SOURCES thay vì chỉ lọc *.openapi.json. Xác minh rằng thay đổi đối với tài liệu cơ sở BReg sẽ kích hoạt job tài liệu và các kiểm tra renderer/Redocly của job đó.

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

Mô tả

Found in review of #2132.

docs/site/scripts/fetch-openapi.mjs renders products/breg/generated/facility/generated/openapi.json as the BReg API reference example. The docs routing in .github/scripts/ci_changes.py does not list that path. A change that only regenerates the facility document therefore skips the docs job, including the renderer and Redocly checks.

The coverage test misses it too: its source extraction accepts only filenames ending in .openapi.json, and this source is named openapi.json.

Fix: add the exact path to the docs patterns, and make the coverage test enumerate every SPEC_SOURCES entry so the next added source cannot slip past.

Ngôn ngữ chính
Rust
Star
2
Fork
0
Merge trung bình
10 giờ 45 phút
Pull request đã merge (30 ngày)
259

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 registrystack/registry-stack

Tất cả issue của registrystack/registry-stack

Issue tương tự

Thêm issue về Rust

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.