build-lectures: `-n` (nitpick) absent from default strictness; no extra-args passthrough via build-jupyter-cache

Abierto
  • ¿Algo no está bien?
#97 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
4/5
Tiempo estimado
3-5 días
Aptitud para principiantes
35/100
Tipo de issue
Nueva funcionalidad
Claridad
Necesita aclaración
Estado de actividad
Tranquilo
Stack tecnológico
github-actions, shell
Área
ci-cd, devops, documentation

Línea de trabajo

Lee build-lectures/action.yml, build-jupyter-cache/action.yml, las plantillas de CI, publicación y caché, y las secciones del README sobre extra-args. Compara los argumentos existentes del builder con los comandos de reproducción en build-jupyter-cache/action.yml:439-443 y confirma las decisiones sobre strictness y passthrough antes de cambiar nada. La tarea estará terminada cuando los flags elegidos lleguen a los consumidores pertinentes, la acción de caché exponga los argumentos acordados y la guía de migración coincida con los comandos de reproducción.

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

Descripción

enhancement

From the v0.8.0 validation study against native lecture-python-intro / lecture-python-programming. Context: QuantEcon/lectures#11.

build-lectures defaults extra-args to -W --keep-going (build-lectures/action.yml:25) — no -n. HTML-only gap: :103-104 hard-codes -n for pdflatex and jupyter, and only the html branch (:102) leaves builder_args empty, so the published site builds without nitpick. build-jupyter-cache calls build-lectures at three fixed with: blocks with no extra-args passthrough (build-jupyter-cache/action.yml:160-190), so its consumers cannot get -n — or any flag — in.

Native practice is not uniform:

  • lecture-python-programming ci.yml:87 + publish.yml:103 — -n -W --keep-going
  • lecture-python-intro ci.yml:86 — -nW --keep-going; publish.yml:91 — none, neither -n nor -W
  • both repos' cache.yml — -W --keep-going

So the default already equals both native cache builds and is stricter than intro's publish; -n diverges only on the CI/publish HTML path, which a direct build-lectures consumer can override.

templates/ci.yml:82 and templates/publish.yml:98 hard-code extra-args: '-W --keep-going', and extra-args replaces rather than extends the default (build-lectures/README.md:190-203): changing the default is a no-op for template-derived consumers, and adding -n but dropping -W silently loses build-failure detection.

Decisions needed before any code

  • Org strictness for HTML builds — add -n? Standardization, not a parity fix, and consumer-visible: repos with broken cross-references start failing CI, so it wants an announcement and a minor release.
  • Passthrough shape — a per-builder html-extra-args beats a blanket extra-args, since pdflatex and jupyter already inject -n and would get it twice.

Then, in this order

  • Apply the decided strictness to templates/ci.yml:82 and templates/publish.yml:98 — that is what reaches consumers.
  • Add the passthrough to build-jupyter-cache/action.yml:42-51, wired at :168/:178/:188, mirroring the upload-failure-reports plumbing from v0.11.0 (#83); update the reproduce commands at :439-443, whose comment (:438) requires them to match today's flags. templates/cache.yml:62 inherits the gap and cannot carry the strictness decision until then.
  • Document the native-equivalent invocation in docs/MIGRATION-GUIDE.md, which never mentions extra-args; the only nitpick guidance is the "Nitpick mode" example at build-lectures/README.md:212.
Lenguaje dominante
Shell
Estrellas
0
Forks
1
Merge medio
20 h 3 min
PR fusionados (30 d)
48

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 QuantEcon/actions

Todos los issues de QuantEcon/actions

Issues similares

Más issues de Shell/Bash

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.