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

オープン
  • 何か問題がありますか？
#40 コメント 1 件 リアクション 0 件 担当者 0 名 GitHub で見る

メンテナーはふだん 1 日以内に返信

まだ誰も着手していません。

評価

難易度
4/5
見積もり時間
3〜5日
初心者へのやさしさ
58/100
issue の種類
機能追加
明瞭さ
明確に書かれている
活発さ
活発
技術スタック
python
領域
build-system, tooling

調査の方向性

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.

索引モデルが issue の本文から書いたものです。

説明

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.

主要言語
Python
スター
1
フォーク
0
平均マージ
1日 3時間
マージ済み PR（30日）
17

環境構築

このプロジェクトには開発コンテナ、Dockerfile、コントリビューションガイドがありません。まず README を読み、一般的な手順ははじめてのコントリビューションガイドを参照してください。

はじめの一歩

  1. issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
  2. 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
  3. リポジトリをフォークし、ブランチを切って変更します。
  4. issue 番号を参照したプルリクエストを送ります。

QuantEcon/lectures のほかの issue

QuantEcon/lectures の issue をすべて見る

似ている issue

Python の issue をもっと見る

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。