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

generate_repo_overview: configure and select Reference Integration branches

Đang mở
  • Có gì không ổn?
#124 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
28/100
Loại issue
Tính năng
Độ rõ ràng
Khá rõ ràng
Mức độ hoạt động
Sôi nổi
Công nghệ
html, python
Lĩnh vực
build-system, developer-experience

Hướng nghiên cứu

Start in generate_repo_overview, where the Reference Integration's MODULE.bazel (and included module files) and known_good.json are read from the default branch, and trace how that data reaches the HTML dashboard. Design the per-ref configuration and cache layout first, since the issue leaves the format open and asks for a decision during implementation. Done when a main branch and a release branch with different pins can both be collected, appear in the dropdown with the default preselected, and switch repository inclusion and pins consistently, while missing refs are reported rather than silently falling back.

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

Mô tả

Why

The overview should let users select which Reference Integration branch they want to inspect. The main development branch and release branches can integrate different repositories and pin different versions; users need to see the integration state relevant to their release.

Currently, generate_repo_overview reads the Reference Integration's MODULE.bazel (including included module files) and known_good.json from the repository's GitHub default branch. The generated dashboard therefore exposes only that integration state.

Expected behavior

  • Add configuration for the Reference Integration refs offered in the dashboard:
    • Main development branch, with a configurable branch name and a default selection.
    • Release branches, selected through an explicit list and/or configurable branch patterns; the exact configuration format can be decided during implementation.
  • Add a dropdown to the HTML dashboard to switch between the collected Reference Integration refs. Clearly show the selected branch.
  • Switch all Reference Integration-derived information consistently, including repository inclusion, pinned versions/commits, and comparisons based on those pins. Read module files and known_good.json from the same selected ref.
  • Collect and persist the data for each configured ref so switching works on the generated static site without live GitHub API access. Keep cached data separate by ref and record the resolved commit for traceability.
  • Preserve the current default-branch behavior when no additional refs are configured. Document how the selected default applies to outputs without an interactive selector.

Optional extension: pull requests

Consider making Reference Integration pull requests available in the same selector, controlled by configuration. This would allow inspecting proposed integration updates before they are merged. If included, define whether the data represents the PR head or its merge result and label the PR and resolved commit clearly. PR support can follow separately from branch selection.

Acceptance criteria

  • Configure a main branch and at least one release branch with different integration pins.
  • Both appear in the dropdown, with the configured default selected initially.
  • Switching branches updates repository inclusion and pin-related values consistently, including any corresponding detail view.
  • Refreshing or collecting one ref does not reuse or overwrite another ref's integration data.
  • Missing or unavailable configured refs are reported clearly rather than silently displaying default-branch data.
Ngôn ngữ chính
Python
Star
0
Fork
14
Merge trung bình
19 giờ 31 phút
Pull request đã merge (30 ngày)
11

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

Dự án này không cung cấp dev container, Dockerfile hay hướng dẫn đóng góp, nên bạn cần tự thiết lập môi trường: hãy bắt đầu từ README và xem hướng dẫn đóng góp lần đầu của chúng tôi để biết các bước chung.

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 eclipse-score/.github

Tất cả issue của eclipse-score/.github

Issue tương tự

Thêm issue về Python

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.