Stop referring to 'master' as a default branch name

Aberta
#41 0 comentários 0 reações 0 responsáveis Ver no GitHub

Ninguém assumiu esta issue ainda.

Avaliação

Dificuldade
3/5
Tempo estimado
Meio dia
Facilidade para iniciantes
70/100
Tipo de issue
Refatoração
Clareza
Claramente especificada
Status de atividade
Ativa
Stack de tecnologia
docker, github-actions, markdown, yaml
Domínio
ci-cd

Direção de pesquisa

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.

Escrita pelo modelo de indexação a partir do texto da issue.

Descrição

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

Linguagem predominante
Sem dados de linguagem
Estrelas
0
Forks
0
Merge médio
2h 6min
PRs com merge (30d)
6

Preparar o ambiente

Este projeto não oferece contêiner de desenvolvimento, Dockerfile nem guia de contribuição, então a configuração fica por sua conta: comece pelo README e veja nosso guia da primeira contribuição para os passos gerais.

Primeiros passos

  1. Leia a issue inteira e depois o guia de contribuição do projeto.
  2. Comente na issue dizendo que vai assumir — evita que duas pessoas façam o mesmo trabalho.
  3. Faça um fork do repositório e trabalhe em uma branch.
  4. Abra um pull request que referencie o número da issue.

Mais de Bioconductor/workflows

Todas as issues de Bioconductor/workflows

Issues semelhantes

Mais issues de DevOps

Receba novas issues na sua caixa de entrada

Um resumo curto de issues do GitHub para quem está começando.