The compose header teardown and `make down` leave profile services running (follow-up to #1285)

Abierto
  • ¿Algo no está bien?
#1,287 1 comentario 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
3/5
Tiempo estimado
1-2 días
Aptitud para principiantes
74/100
Tipo de issue
Error
Claridad
Bien especificado
Estado de actividad
Activo
Stack tecnológico
docker, docker-compose, python, yaml
Área
devops, documentation, testing

Línea de trabajo

Start with the docker-compose.yml profile declarations and the teardown commands in docker-compose.yml, Makefile, and the three getting-started pages mentioned through CONTRIBUTING.md. Update the regression test at backend/tests/unit/docs/test_demo_profile_command.py::test_the_header_and_the_two_pages_print_the_same_command to cover the header and all three pages. Done means each full-teardown command names exactly the demo, tools, and aws profiles, the regression test passes, docker compose config remains byte-identical, and the named-volume persistence assertions still hold.

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

Descripción

bug documentation post-launch

Follow-up to #1285. That issue fixes the three getting-started pages. Two more copies of the same teardown remain,
and they stay as they are in v0.36.1:

  • docker-compose.yml line 16, the header comment: docker compose down -v # stop and drop the volumes, directly
    under the header's --profile demo, --profile tools and --profile aws start lines.
  • Makefile lines 82-83, the down target: $(COMPOSE) down -v --remove-orphans, which CONTRIBUTING.md line 114
    documents as "Stop everything and drop the volumes", right under make demo.

Why --remove-orphans does not help

From Compose's source (v2.24.5 and v2.38.2): down removes containers only for the services in the loaded project, and
services whose profile is not enabled are "disabled", not absent. isOrphaned counts both enabled and disabled services
as defined, so a disabled-profile container is never an orphan. After make demo, make down leaves shoplab,
streampulse and both simulators running, with the same effects as in #1285.

Scope of the fix (one PR)

  • The header teardown and the down recipe name every profile; CONTRIBUTING.md line 114 becomes true.
  • A regression test (markers unit and regression, standard library only, no git) asserting that every documented
    full teardown names exactly the set of profiles declared in docker-compose.yml: the three pages' fenced
    docker compose … down lines, the header line and the Makefile recipe. The PR shows it failing on a page reverted to
    docker compose down -v and on a page without --profile aws.
  • backend/tests/unit/docs/test_demo_profile_command.py::test_the_header_and_the_two_pages_print_the_same_command is
    adjusted so that a header demo start line without the seeds still fails.
  • docker compose config is byte-identical before and after.
  • An assertion that the tools and aws services keep their data in named volumes, against which the pages' new
    "also deletes pgAdmin's and LocalStack's data" sentences are re-registered.

The regression test is deliberately not part of #1285's PR, so that v0.36.1 stays docs-only.

Lenguaje dominante
Python
Estrellas
0
Forks
4
Merge medio
5 h 19 min
PR fusionados (30 d)
503

Preparar el entorno

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 Controlvar/controlvar

Todos los issues de Controlvar/controlvar

Issues similares

Más issues de Python

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.