Freeze: `execute: freeze` and `--use-freezer` are silently ignored; requirements from Great Docs

未关闭
#1,204 0 条评论 0 个 reaction 已指派 0 人 在 GitHub 查看

维护者通常 1 天内回复

还没有人认领这个 Issue。

评估

难度
4/5
预计耗时
3-5 天
新手友好度
25/100
Issue 类型
功能
描述清晰度
基本清楚
活跃度
活跃
技术栈
rust

调研方向

Start with the flag and the hard-coded option: --use-freezer is parsed in crates/quarto/src/main.rs but never read, and use_freeze: false is set where pass 2 builds RenderOptions in crates/quarto-core/src/project/pass2_renderer.rs. The first deliverable is a warning when execute: freeze or --use-freezer is used, pointing to execution records. The freeze design itself needs the plan in claude-notes/plans/2026-10-28-execution-records-epic.md, so a design note is the other part of done.

由索引模型根据 Issue 内容生成。

描述

This issue was written by Claude while adding q2 support to Great Docs. The output shown comes from running each repro.

Description

q2 doesn't implement execute: freeze yet. I know freeze is planned as a later epic built on the
execution records (the .ipynb format in
claude-notes/plans/2026-10-28-execution-records-epic.md). This issue is to (1) report two silent
no-ops in the meantime, and (2) list what Great Docs needs from freeze, as input to that design.

Current behavior
  • execute: freeze: auto in _quarto.yml is accepted without a warning and does nothing: every
    render runs every cell, and nothing is written to _freeze/.
  • q2 render --use-freezer is accepted without a warning and does nothing. The flag is parsed
    (crates/quarto/src/main.rs) but never read, and use_freeze: false is hard-coded where pass 2
    builds its RenderOptions (crates/quarto-core/src/project/pass2_renderer.rs).

A project that relies on freeze therefore builds fine on a machine that has every dependency, and
then fails, or slowly recomputes everything, in CI.

Execution records already get close. With execute: {record: true, record-sources: "q2,engine"}
in _quarto.yml, a second q2 render reuses each page's record from
.quarto/execution-records/ instead of running its cells, and re-runs only the pages whose code
changed. That's essentially freeze: auto. With record-sources: "q2" alone, nothing runs, which is
the CI case. Records also survive moving the project to another directory. Two things I noticed:

  • Removing record: true while keeping record-sources makes every record stale ("the document's
    code or options changed since it was recorded"), so it re-runs the cells, or with q2 alone
    shows no output. The plan says record is excluded from the document hash, so this may be a bug.
  • q2 render page.qmd reuses the record. Quarto 1 re-executes a page rendered on its own, even
    when it's frozen, and that's how a single page is refreshed.
What Great Docs needs

Great Docs builds a Quarto project from a package's docs. Its freeze support works like this today:

  • Great Docs turns on execute: freeze: auto by default. A page can set freeze: true, so it runs
    only when asked to, or freeze: false, so it runs on every build.
  • Every build restores docs/_freeze/ into the generated project before quarto render, and copies
    the updated cache back afterwards. Authors commit docs/_freeze/, so in CI, pages with heavy or
    private dependencies (model training, API calls, databases) don't run.
  • great-docs freeze <page> renders one page with quarto render <page>, which executes it even if
    it's frozen, then saves the cache back to docs/_freeze/.
  • Versioned docs keep a separate cache per version, which Great Docs copies between build
    directories, so a cache has to be relocatable, with nothing absolute inside it.

For that to work under q2, it needs:

  1. A committed, shareable location. .quarto/ is usually gitignored, and the records guide
    currently says a record "is not something to commit". Freeze is the durable use. Either a
    _freeze/-style directory, or a documented way to point the record location somewhere
    committable.
  2. freeze: auto semantics. Reuse when the page's code and execution options are unchanged;
    re-run otherwise. Records' staleness rules look right for this; prose edits not invalidating is
    an improvement on Quarto 1.
  3. freeze: true semantics. Never execute in a project render. The current
    record-sources: "q2" behavior (show no output, with a warning, when the record is stale) is
    fine, as long as the warning is visible and maybe opt-in to an error for CI.
  4. A way to force re-execution of one page, ideally the Quarto 1 rule that rendering a named file
    executes it. Then great-docs freeze and quarto render page.qmd keep their meaning.
  5. A migration story for Quarto 1's _freeze/. Importing it is out of scope in the epic, which
    is fine. A note in the docs saying "re-render frozen pages once with q2" would be enough, as long
    as the q2 cache doesn't collide with an existing _freeze/ directory.
  6. Until then, a warning when execute: freeze or --use-freezer is used, pointing to
    execution records, so the no-op isn't silent.

A short design note on how freeze will map onto records (location, the keys, single-file renders),
before it's built, would let us plan the Great Docs side.

Related: #45 (hub: freeze updates with incoming syntax errors?).

主要语言
Rust
星标
302
派生
22
平均合并
5 小时 2 分钟
30 天内合并 PR
213

环境准备

  • 没有 Dockerfile 或 Docker Compose 文件
  • 没有 Pull Request 模板
  • 阅读贡献指南

从这里开始

  1. 先读完整个 Issue,再读项目的贡献指南。
  2. 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
  3. Fork 仓库,在一个分支上完成修改。
  4. 提交 Pull Request,并在描述里引用这个 Issue 编号。

quarto-dev/q2 的其他 Issue

查看 quarto-dev/q2 的全部 Issue

相似的 Issue

更多 Rust Issue

把新 issue 发到你的邮箱

精选适合新手参与的 GitHub issue 摘要。