Stop referring to 'master' as a default branch name

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

Chưa có ai nhận issue này.

Đánh giá

Độ khó
3/5
Thời gian dự kiến
Nửa ngày
Mức phù hợp với người mới
70/100
Loại issue
Tái cấu trúc
Độ rõ ràng
Đặc tả rõ ràng
Mức độ hoạt động
Sôi nổi
Công nghệ
docker, github-actions, markdown, yaml
Lĩnh vực
ci-cd

Hướng nghiên cứu

Start with the master entries in the branch lists of ci.yml and the docs/index.html generator, then the container-tag mapping in .github/workflows/bioccheck.yml and the text in bioccheck_usage.md. Remove master from the default branch lists, decide whether to keep or drop the master to devel mapping, and add the blog-post note to bioccheck_usage.md. Leave docs/adr/0001 unchanged. Done when no default-branch list names master and the usage doc links the renaming post.

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

Mô tả

Bioconductor renamed its default branch from master to devel in March 2023, during the 3.17 devel cycle (Renaming the Default Branch to Devel). Since then, maintainers have pushed to devel on git.bioconductor.org. However, the workflows and their docs still list master as one of the default branch names, so every package that copies the ci.yml template inherits master in its trigger lists.

Places where master refers to a default branch (as of d77d800):

Suggested changes

  1. Remove master from the branch lists in the ci.yml template and the generator, leaving [ devel, main, RELEASE_* ].
  2. Remove master from bioccheck_usage.md, and add a note that links to the blog post for repositories that still use master.
  3. In bioccheck.yml, either:
    • keep the master → devel mapping for backward compatibility and leave it undocumented, or
    • drop it, so a master branch falls through to the existing "defaulting to devel container" warning. The container stays the same, and maintainers are prompted to rename the branch.
  4. Leave ADR 0001 as it is, since it is a historical record. If it is superseded, record that in a new ADR.

Repositories still on master keep working under either option for step 3, because unrecognized branch names already default to the devel container.

Drafted with Claude Opus 5.5

Ngôn ngữ chính
Không có dữ liệu ngôn ngữ
Star
0
Fork
0
Merge trung bình
2 giờ 6 phút
Pull request đã merge (30 ngày)
6

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 Bioconductor/workflows

Tất cả issue của Bioconductor/workflows

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.