Skip to content

Commit 723fffb

Browse files
authored
docs: update chromium references for deprecation in v1.10 (#1984)
Cherry-pick of #1983 (stable docs) with v1.10-specific adjustments. The auto-backport failed due to CLI reference conflicts with #1982. - Deprecation callout documents transparent redirect behavior: `quarto install chromium` installs chrome-headless-shell and auto-removes legacy chromium - Sample quarto check output uses v1.10.2 with "Chromium (deprecated)" label - Binder description updated to Chrome Headless Shell - Preview workflow excludes CLAUDE.md from changed-files detection - CLI reference files unchanged (already correct from #1982) Companion to quarto-dev/quarto-cli#14334
1 parent d6e8ecd commit 723fffb

File tree

8 files changed

+70
-36
lines changed

8 files changed

+70
-36
lines changed
Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
# quarto-web Workflow
2+
3+
## Stable → Prerelease
4+
5+
1. PRs target `main` (stable/released docs)
6+
2. On merge, `port-to-prerelease.yml` (korthout/backport-action) auto-creates a cherry-pick PR to `prerelease`
7+
3. Prerelease-specific changes (e.g., v1.10 features) are layered in a follow-up PR after the backport merges
8+
9+
Always PR to `main` first for shared content. Never PR directly to `prerelease` for changes that apply to both stable and prerelease.
10+

.github/workflows/preview.yml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -155,6 +155,8 @@ jobs:
155155
docs/reference/**/*.json
156156
docs/cli/*.json
157157
docs/**/images/*.png
158+
files_ignore: |
159+
**/CLAUDE.md
158160
json: true
159161
escape_json: false
160162

bug-reports.qmd

Lines changed: 16 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -100,44 +100,46 @@ For instance, the markdown code you would provide might look like this:
100100

101101
````md
102102
```bash
103-
Quarto 1.5.42
103+
Quarto 1.10.2
104104
[✓] Checking versions of quarto binary dependencies...
105-
Pandoc version 3.2.0: OK
105+
Pandoc version 3.4.0: OK
106106
Dart Sass version 1.70.0: OK
107-
Deno version 1.41.0: OK
107+
Deno version 1.46.3: OK
108108
Typst version 0.11.0: OK
109109
[✓] Checking versions of quarto dependencies......OK
110110
[✓] Checking Quarto installation......OK
111-
Version: 1.5.42
111+
Version: 1.10.2
112112
Path: /Applications/quarto/bin
113113

114114
[✓] Checking tools....................OK
115-
TinyTeX: v2024.03.13
116-
Chromium: (not installed)
115+
TinyTeX: v2026.04
116+
Chromium (deprecated): (not installed)
117+
Chrome Headless Shell: (not installed)
118+
VeraPDF: (not installed)
117119

118120
[✓] Checking LaTeX....................OK
119121
Using: TinyTex
120122
Path: /Users/username/Library/TinyTeX/bin/universal-darwin
121-
Version: 2024
123+
Version: 2026
122124

123125
[✓] Checking basic markdown render....OK
124126

125127
[✓] Checking Python 3 installation....OK
126128
Version: 3.12.1
127129
Path: /.venv/bin/python3
128130
Jupyter: 5.7.2
129-
Kernels: julia-1.10, python3
131+
Kernels: python3
130132

131133
[✓] Checking Jupyter engine render....OK
132134

133135
[✓] Checking R installation...........OK
134-
Version: 4.3.3
135-
Path: /Library/Frameworks/R.framework/Versions/4.3-arm64/Resources
136+
Version: 4.4.2
137+
Path: /Library/Frameworks/R.framework/Versions/4.4-arm64/Resources
136138
LibPaths:
137-
- /Users/username/Library/R/arm64/4.3/library
138-
- /Library/Frameworks/R.framework/Versions/4.3-arm64/Resources/library
139-
knitr: 1.45
140-
rmarkdown: 2.26
139+
- /Users/username/Library/R/arm64/4.4/library
140+
- /Library/Frameworks/R.framework/Versions/4.4-arm64/Resources/library
141+
knitr: 1.49
142+
rmarkdown: 2.29
141143

142144
[✓] Checking Knitr engine render......OK
143145
```

docs/authoring/diagrams.qmd

Lines changed: 11 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -246,8 +246,16 @@ quarto install chrome-headless-shell
246246

247247
[Chrome Headless Shell](https://developer.chrome.com/blog/chrome-headless-shell) is a lightweight, headless-only browser from Google's [Chrome for Testing](https://developer.chrome.com/blog/chrome-for-testing) infrastructure. It has fewer system dependencies than full Chromium, making it a good fit for Docker containers and WSL environments.
248248

249-
::: callout-note
250-
## Legacy Chromium
249+
::: callout-warning
250+
## Chromium (Deprecated)
251+
252+
The `quarto install chromium` command is deprecated. It transparently redirects to `chrome-headless-shell` — running `quarto install chromium` installs Chrome Headless Shell and automatically removes any legacy Chromium installation. CI pipelines using `quarto install chromium --no-prompt` continue to work without changes.
253+
254+
To install Chrome Headless Shell directly:
255+
256+
``` {.bash filename="Terminal"}
257+
quarto install chrome-headless-shell
258+
```
251259

252-
The older `quarto install chromium` command (which installs Chromium via Puppeteer) is still available but no longer recommended. If you use it, note that the Puppeteer-bundled Chromium may not work in Docker or WSL — see [Puppeteer troubleshooting](https://github.com/puppeteer/puppeteer/blob/main/docs/troubleshooting.md#running-puppeteer-in-docker) for details.
260+
This also automatically removes any legacy Puppeteer Chromium. The `chromium` tool will be removed from the registry in a future release.
253261
:::

docs/cli/includes/CLAUDE.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
# CLI Reference: Auto-Generated Files
2+
3+
Files in this directory are auto-generated. Do not edit manually.
4+
5+
## Regeneration
6+
7+
1. `quarto dev-call cli-info > docs/cli/cli-info.json`
8+
2. `Rscript --vanilla _tools/reference-cli-generate-md.R`
9+
10+
Descriptions come from quarto-cli source. To change them permanently, update the CLI command definitions in quarto-cli.

docs/output-formats/pdf-engine.qmd

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -44,9 +44,11 @@ which will provide a list of available tools, the installed versions, and the la
4444
``` bash
4545
[✓] Inspecting tools
4646

47-
Tool Status Installed Latest
48-
chromium Not installed --- 869685
49-
tinytex Up to date v2022.10 v2022.10
47+
Tool Status Installed Latest
48+
chrome-headless-shell Not installed --- 147.0.7727.56
49+
chromium Not installed --- 869685
50+
tinytex Up to date v2026.04 v2026.04
51+
verapdf Not installed --- 1.28.2
5052
```
5153

5254
To update to the latest version, use the command:

docs/projects/binder.qmd

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -116,7 +116,7 @@ The following files may be generated by the `quarto use binder` command. Note th
116116

117117
`postBuild`
118118

119-
: The post build script runs code after restoring the environment. This script is generated with commands required to ensure the proper version of Quarto is present in the environment, install any required tools like TinyTex or Chromium, and to configure VSCode and the Quarto extension for VSCode when applicable.
119+
: The post build script runs code after restoring the environment. This script is generated with commands required to ensure the proper version of Quarto is present in the environment, install any required tools like TinyTeX or Chrome Headless Shell, and to configure VSCode and the Quarto extension for VSCode when applicable.
120120

121121
`apt.txt`
122122

docs/troubleshooting/index.qmd

Lines changed: 15 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -13,46 +13,46 @@ but this page might help you get up and running quickly.
1313
You can check the version of Quarto and its dependencies by running `quarto check`. Here's an example of the output it generates:
1414

1515
```
16-
Quarto 1.6.30
17-
[✓] Checking environment information...
18-
Quarto cache location: /Users/cscheid/Library/Caches/quarto
16+
Quarto 1.10.2
1917
[✓] Checking versions of quarto binary dependencies...
2018
Pandoc version 3.4.0: OK
2119
Dart Sass version 1.70.0: OK
2220
Deno version 1.46.3: OK
2321
Typst version 0.11.0: OK
2422
[✓] Checking versions of quarto dependencies......OK
2523
[✓] Checking Quarto installation......OK
26-
Version: 1.6.30
27-
Path: /Users/cscheid/repos/github/cscheid/quarto-regress/releases/v1.6.30/binQuarto 1.5.42
24+
Version: 1.10.2
25+
Path: /Applications/quarto/bin
2826
2927
[✓] Checking tools....................OK
30-
TinyTeX: v2024.03.13
31-
Chromium: (not installed)
28+
TinyTeX: v2026.04
29+
Chromium (deprecated): (not installed)
30+
Chrome Headless Shell: (not installed)
31+
VeraPDF: (not installed)
3232
3333
[✓] Checking LaTeX....................OK
3434
Using: TinyTex
3535
Path: /Users/username/Library/TinyTeX/bin/universal-darwin
36-
Version: 2024
36+
Version: 2026
3737
3838
[✓] Checking basic markdown render....OK
3939
4040
[✓] Checking Python 3 installation....OK
4141
Version: 3.12.1
4242
Path: /.venv/bin/python3
4343
Jupyter: 5.7.2
44-
Kernels: julia-1.10, python3
44+
Kernels: python3
4545
4646
[✓] Checking Jupyter engine render....OK
4747
4848
[✓] Checking R installation...........OK
49-
Version: 4.3.3
50-
Path: /Library/Frameworks/R.framework/Versions/4.3-arm64/Resources
49+
Version: 4.4.2
50+
Path: /Library/Frameworks/R.framework/Versions/4.4-arm64/Resources
5151
LibPaths:
52-
- /Users/username/Library/R/arm64/4.3/library
53-
- /Library/Frameworks/R.framework/Versions/4.3-arm64/Resources/library
54-
knitr: 1.45
55-
rmarkdown: 2.26
52+
- /Users/username/Library/R/arm64/4.4/library
53+
- /Library/Frameworks/R.framework/Versions/4.4-arm64/Resources/library
54+
knitr: 1.49
55+
rmarkdown: 2.29
5656
5757
[✓] Checking Knitr engine render......OK
5858
```

0 commit comments

Comments
 (0)