Stop referring to 'master' as a default branch name

Abierto
#41 0 comentarios 0 reacciones 0 asignados Ver en GitHub

Nadie ha tomado este issue todavía.

Evaluación

Dificultad
3/5
Tiempo estimado
Medio día
Aptitud para principiantes
70/100
Tipo de issue
Refactorización
Claridad
Bien especificado
Estado de actividad
Activo
Stack tecnológico
docker, github-actions, markdown, yaml
Área
ci-cd

Línea de trabajo

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.

Escrito por el modelo de indexación a partir del texto del issue.

Descripción

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

Lenguaje dominante
Sin datos de lenguaje
Estrellas
0
Forks
0
Merge medio
2 h 6 min
PR fusionados (30 d)
6

Preparar el entorno

Este proyecto no incluye contenedor de desarrollo, Dockerfile ni guía de contribución, así que la configuración corre por tu cuenta: empieza por su README y consulta nuestra guía para la primera contribución para los pasos generales.

Primeros pasos

  1. Lee el issue completo y luego la guía de contribución del proyecto.
  2. Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
  3. Haz un fork del repositorio y trabaja en una rama.
  4. Abre un pull request que haga referencia al número del issue.

Más de Bioconductor/workflows

Todos los issues de Bioconductor/workflows

Issues similares

Más issues de DevOps

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.