chore(build): the feature matrix lives only in a 1,088-line hand-enumerated Makefile

Abierto
  • ¿Algo no está bien?
#465 0 comentarios 0 reacciones 0 asignados Ver en GitHub

Los mantenedores suelen responder en 1 día

Nadie ha tomado este issue todavía.

Evaluación

Dificultad
5/5
Tiempo estimado
Más de una semana
Aptitud para principiantes
35/100
Tipo de issue
Refactorización
Claridad
Bastante claro
Estado de actividad
Activo
Stack tecnológico
rust
Área
build-system, ci-cd

Línea de trabajo

Start by comparing the Makefile targets build, test, clippy, doc, and test-embedded with the CI calls in ci.yml at commit d9c7be0. Map the existing feature combinations and check whether any are missing from a target, then inspect the crate manifests to identify declared features. Choose one of the suggested approaches and add a check that every declared feature appears in at least one tested combination.

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

Descripción

enhancement

Problem

Makefile is 1,088 lines, and most of it is hand-written cargo build|test|clippy|doc|check --package … --features "…" lines, one per crate and feature combination, repeated across the build, test, clippy, doc and test-embedded targets. CI calls these targets (make clippy, make test, make test-embedded, make check, make all), so the Makefile is the only place the supported feature matrix is written down.

Consequences:

  • Adding or renaming a feature means editing the same combination in up to five targets, plus the crate manifest. Nothing checks that the five stay aligned, so a combination can be built but not linted, or linted but not documented.
  • The matrix cannot be read by tools (e.g. to check that every declared feature is exercised at least once).
  • It is the main reason the deprecated feature aliases are still in use in-tree.

Suggested work

Options, roughly in order of effort:

  1. Define each crate's feature combinations once as Make variables and have build / test / clippy / doc iterate over them.
  2. Move the matrix into a small data file (TOML) consumed by an xtask or script, with the Makefile targets as thin wrappers.
  3. Use cargo hack --feature-powerset (with exclusions) for the host crates and keep explicit lists only for the embedded targets.

Whatever the choice, add a check that every feature declared in a crate manifest appears in at least one tested combination.

Notes

Based on reading the Makefile and ci.yml at d9c7be0. I did not check for combinations that are already missing from one of the targets; that would be a useful first step.

Lenguaje dominante
Rust
Estrellas
101
Forks
20
Merge medio
2 h 33 min
PR fusionados (30 d)
90

Preparar el entorno

Abrir en Codespaces

Inicia el contenedor de desarrollo del proyecto en tu navegador, con tu propia cuenta de GitHub.

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 aimdb-dev/aimdb

Todos los issues de aimdb-dev/aimdb

Issues similares

Más issues de Rust

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.