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

Aperta
  • Qualcosa non va?
#97 0 commenti 0 reazioni 0 assegnatari Vedi su GitHub

I maintainer di solito rispondono entro 1 giorno

Nessuno ha ancora preso questa issue.

Valutazione

Difficoltà
4/5
Tempo stimato
3-5 giorni
Idoneità per principianti
35/100
Tipo di issue
Funzionalità
Chiarezza
Da chiarire
Stato di attività
Tranquilla
Stack tecnologico
github-actions, shell
Ambito
ci-cd, devops, documentation

Direzione di ricerca

Leggi build-lectures/action.yml, build-jupyter-cache/action.yml, i template di CI, pubblicazione e cache e le sezioni del README relative a extra-args. Confronta gli argomenti esistenti del builder con i comandi di riproduzione in build-jupyter-cache/action.yml:439-443, quindi conferma le decisioni su strictness e passthrough prima di modificare qualsiasi cosa. Il lavoro è completato quando i flag scelti raggiungono i consumer pertinenti, l’azione di cache espone gli argomenti concordati e le istruzioni di migrazione corrispondono ai comandi di riproduzione.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Descrizione

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.
Lingua principale
Shell
Stelle
0
Fork
1
Merge medio
20h 3m
PR unite (30g)
48

Preparare l'ambiente

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Altre issue di QuantEcon/actions

Tutte le issue di QuantEcon/actions

Issue simili

Altre issue su Shell/Bash

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.