promote: a pool lecture renamed or removed upstream can never be retired, and every refresh after it fails

Aperta
  • Qualcosa non va?
#40 1 commento 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
58/100
Tipo di issue
Funzionalità
Chiarezza
Specificata chiaramente
Stato di attività
Attiva
Stack tecnologico
python
Ambito
build-system, tooling

Direzione di ricerca

Read tools/drift-check around the canonical-removed finding and tools/promote around refresh failures and the generated ledger. Trace how lecture entries and their assets are recorded, then inspect the existing promotion tests. Add coverage for renames, removals, and assets used only by a retired lecture; done means a supported retirement workflow clears drift and later refreshes succeed.

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

Descrizione

bug

Found by the review of intro's promotion for step 2 of QuantEcon/project-monorepo#24. The gap predates that promotion, but each series promoted widens it: intro adds 50 lectures to the pool, and intro changed its _toc.yml 11 times in the last six months. Line numbers are at main 83f0179.

What happens. Reproduced on a copy of the pool with intro promoted, by renaming intro's cobweb.md to cobweb_intro.md in its mirror and its toc and moving intro's pin:

  1. tools/drift-check reports two drift findings: [toc-changed] intro and [canonical-removed] lectures/cobweb.md: canonical copy intro/lectures/cobweb.md no longer exists upstream.
  2. The toc-changed remedy (tools/promote --toc intro --exclude jax, then tools/drift-check --accept-toc intro) promotes cobweb_intro, but leaves lectures/cobweb.md and its ledger entry in place at the old pin, so the pool holds both.
  3. The next night that any intro lecture moves (here solow, with the pin moved again), the workflow's refresh (tools/promote --refresh --exclude jax) fails on the old entry and exits 1, so the run is red: [cobweb] FAILED: cobweb.md is in the pool, but no canonical-eligible series this run considers holds it any more (removed or renamed upstream?).
  4. It fails the same way every night after that.

Why nothing clears it. canonical-removed asks for a decision "before the next refresh" (tools/drift-check:322), and the refresh's FAILED line asks for the same one (tools/promote:677-680), but no tool carries the decision out. Nothing removes a pool lecture together with its ledger entry, and the ledger's header says it is generated and must not be hand-edited (tools/promote:146). The toc-changed remedy text (tools/drift-check:583-589) does not mention the old entry.

Removing lectures/cobweb.md and its ledger block by hand, in one commit, does clear it: drift-check is clean and the next refresh succeeds. But that is the hand edit the header forbids, and a lecture with assets of its own would need their records removed as well.

What a fix needs. A sanctioned way to retire an entry: remove the pool lecture, its ledger entry and any asset only it uses. Two shapes, not exclusive:

  • an explicit tools/promote --retire <lecture>, which the canonical-removed detail and the FAILED line then name;
  • a --toc run that retires the entries whose lecture has left the toc and whose canonical copy is gone, which also makes the toc-changed remedy complete for a rename.

Either way, with tests for a rename, a removal, and a retired lecture's own assets.

Lingua principale
Python
Stelle
1
Fork
0
Merge medio
1g 3h
PR unite (30g)
17

Preparare l'ambiente

Questo progetto non fornisce container di sviluppo, Dockerfile né guida per i contributori, quindi l'ambiente è a tuo carico: parti dal suo README e consulta la nostra guida al primo contributo per i passaggi generali.

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/lectures

Tutte le issue di QuantEcon/lectures

Issue simili

Altre issue su Python

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.