Freeze: `execute: freeze` and `--use-freezer` are silently ignored; requirements from Great Docs
Maintainers usually reply within 1 day
Nobody has claimed this yet.
Assessment
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Newbie friendliness
- 25/100
- Issue type
- Feature
- Clarity
- Mostly clear
- Activity status
- Active
- Tech stack
- rust
- Domain
- build-system, ci-cd
Research direction
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.
Written by the indexing model from the issue text.
Description
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: autoin_quarto.ymlis accepted without a warning and does nothing: every
render runs every cell, and nothing is written to_freeze/.q2 render --use-freezeris accepted without a warning and does nothing. The flag is parsed
(crates/quarto/src/main.rs) but never read, anduse_freeze: falseis hard-coded where pass 2
builds itsRenderOptions(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: truewhile keepingrecord-sourcesmakes every record stale ("the document's
code or options changed since it was recorded"), so it re-runs the cells, or withq2alone
shows no output. The plan saysrecordis excluded from the document hash, so this may be a bug. q2 render page.qmdreuses 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: autoby default. A page can setfreeze: true, so it runs
only when asked to, orfreeze: false, so it runs on every build. - Every build restores
docs/_freeze/into the generated project beforequarto render, and copies
the updated cache back afterwards. Authors commitdocs/_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 withquarto render <page>, which executes it even if
it's frozen, then saves the cache back todocs/_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:
- 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. freeze: autosemantics. 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.freeze: truesemantics. 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.- A way to force re-execution of one page, ideally the Quarto 1 rule that rendering a named file
executes it. Thengreat-docs freezeandquarto render page.qmdkeep their meaning. - 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. - Until then, a warning when
execute: freezeor--use-freezeris 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?).
- Dominant language
- Rust
- Stars
- 302
- Forks
- 22
- Avg merge
- 5h 2m
- Merged PRs (30d)
- 213
Getting set up
- No Dockerfile or Docker Compose file
- No pull request template
- Read the contributing guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from quarto-dev/q2
-
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
quarto-dev/q2#1219 ·
Maintainers usually reply within 1 day
-
Difficulty 2/5 1-3 hours Newbie friendliness 75/100
quarto-dev/q2#1188 · 3 comments ·
Maintainers usually reply within 1 day
-
Difficulty 2/5 1-3 hours Newbie friendliness 73/100
quarto-dev/q2#1179 ·
Maintainers usually reply within 1 day
-
Difficulty 2/5 1-3 hours Newbie friendliness 82/100
quarto-dev/q2#1133 ·
Maintainers usually reply within 1 day
-
Difficulty 2/5 1-3 hours Newbie friendliness 76/100
quarto-dev/q2#1103 · 1 comment ·
Maintainers usually reply within 1 day
Similar issues
-
priority: low
Difficulty 2/5 1-3 hours Newbie friendliness 67/100
storytold/photocraft#15350 ·
Maintainers usually reply within 1 day
-
area:davinci
Difficulty 2/5 1-3 hours Newbie friendliness 72/100
ubugeeei-prod/vize#13167 ·
Maintainers usually reply within 1 day
-
area:ui enhancement
Difficulty 2/5 1-3 hours Newbie friendliness 74/100
transit-audio/transit#738 ·
Maintainers usually reply within 1 day
-
enhancement good first issue help wanted
Difficulty 2/5 1-3 hours Newbie friendliness 91/100
hocinehacherouf/liberarr#78 ·
Maintainers usually reply within 1 day
-
bug
Difficulty 2/5 1-3 hours Newbie friendliness 68/100
Maintainers usually reply within 1 day