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

Route v13 API-docs CI and publication to website branch v13

Đang mở
  • Có gì không ổn?
#8,753 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ó
3/5
Thời gian dự kiến
1-2 ngày
Mức phù hợp với người mới
40/100
Loại issue
Lỗi
Độ rõ ràng
Khá rõ ràng
Mức độ hoạt động
Sôi nổi
Công nghệ
github-actions
Lĩnh vực
ci-cd

Hướng nghiên cứu

Start with the api-docs job in .github/workflows/ci.yml and the publish job in .github/workflows/publish.yml, and find where each checks out the website's default branch. Add a step that derives the compiler major from the version, including prereleases, and maps 12 to master and 13 to v13. Then confirm that the artifact lands in data/api and that publishing commits to the chosen branch. Done means both workflows select the branch correctly for stable and alpha versions, and the v12 path is unchanged. Website #1433 must land first.

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

Mô tả

Compiler master generates v13 API snapshots, but both the API-docs CI check and release publication check out the website's default branch. Website master selects v12 data, so building it with a new v13 artifact does not validate v13 API pages, and publishing there does not update the website's v13 branch.

Target branch: compiler master (v13). This changes workflow routing, not compiler language behavior.

  • In .github/workflows/ci.yml, make the api-docs job check out the matching website branch before downloading and building the generated artifact.
  • In .github/workflows/publish.yml, use the same branch mapping for the website checkout, build, and API-data commit/push.
  • Map compiler major 12 to website master, and compiler major 13 to website v13. Derive the major from the compiler/release version, including prereleases.
  • Download artifacts into repository-root data/api, and require a successful build of the matching website before publishing its API-data changes.

Acceptance: v13 CI builds website branch v13 with the incoming v13 snapshot; v13 release publication commits that snapshot to v13 and triggers the appropriate website deployment. Verify branch selection for stable and alpha versions, and preserve the v12 maintenance publication path to website master.

Prerequisite: website #1433 must land first so the v13 website consumes and validates the published data. Confirm the v13 website deployment trigger as part of the coordinated rollout.

Related: website #1391 and website PR #1432.

Ngôn ngữ chính
OCaml
Star
7.5k
Fork
484
Merge trung bình
19 giờ 46 phút
Pull request đã merge (30 ngày)
81

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 rescript-lang/rescript

Tất cả issue của rescript-lang/rescript

Issue tương tự

Thêm issue về DevOps

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.