Stop referring to 'master' as a default branch name

未關閉
#41 0 則留言 0 個 reaction 已指派 0 人 在 GitHub 檢視

還沒有人認領這個 Issue。

評估

難度
3/5
預估耗時
半天
新手友好度
70/100
Issue 類型
重構
描述清晰度
描述清楚
活躍度
活躍
技術堆疊
docker, github-actions, markdown, yaml
領域
ci-cd

研究方向

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.

由索引模型根據 Issue 內容生成。

描述

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

主要語言
沒有語言資料
星號
0
分支
0
平均合併
2 小時 6 分鐘
30 天內合併 PR
6

環境準備

這個專案沒有提供開發容器、Dockerfile 或貢獻指南,環境需要你自己搭建:先看它的 README,通用步驟見我們的新手貢獻指南。

從這裡開始

  1. 先讀完整個 Issue,再讀專案的貢獻指南。
  2. 在 Issue 下留言說明你要接手 —— 這能避免兩個人做同樣的事。
  3. Fork 儲存庫,在一個分支上完成修改。
  4. 送出 Pull Request,並在描述裡引用這個 Issue 編號。

Bioconductor/workflows 的其他 Issue

查看 Bioconductor/workflows 的全部 Issue

相似的 Issue

更多 DevOps Issue

把新 issue 寄到你的電子郵件信箱

精選適合新手參與的 GitHub issue 摘要。