diff --git a/dev-docs/cross-project-dependencies.md b/dev-docs/cross-project-dependencies.md index c2223edcf9..e9078dc804 100644 --- a/dev-docs/cross-project-dependencies.md +++ b/dev-docs/cross-project-dependencies.md @@ -65,6 +65,11 @@ format of editor-support commands is a cross-project change. 3. For filters: confirm inline-list membership in `prepare-dist.ts`. 4. Coordinate a companion PR in the consumer if the contract changes. +Bumping the bundled Pandoc version counts as touching a shared surface: +Pandoc Markdown-writer changes alter the visual-editor roundtrip output in +`quarto-dev/quarto` and can break its snapshot tests. See the last item of +[`update-pandoc-checklist.md`](update-pandoc-checklist.md). + ## History - Removing `crossref-standalone.lua` and `quarto-pre/quarto-pre.lua`: verified diff --git a/dev-docs/update-pandoc-checklist.md b/dev-docs/update-pandoc-checklist.md index 230241e65b..2613107db5 100644 --- a/dev-docs/update-pandoc-checklist.md +++ b/dev-docs/update-pandoc-checklist.md @@ -29,3 +29,4 @@ Partials: - [ ] Update schemas by inspecting [their changelog](https://github.com/jgm/pandoc/blob/main/changelog.md) for new commands, deprecation removals, etc - [ ] Update lua-types if needed by inspecting the diff of [lua-filters.md](https://github.com/jgm/pandoc/commits/main/doc/lua-filters.md) +- [ ] Check [`quarto-dev/quarto`](https://github.com/quarto-dev/quarto) (the visual-editor / VS Code tooling repo) for roundtrip **snapshot** test breakage on the next **prerelease**. Pandoc Markdown-*writer* changes — e.g. display-math newline handling, bullet/definition-list indentation — change visual-editor roundtrip output and break `apps/vscode/src/test/examples/generated_snapshots/*.qmd`. If output changed, open a companion PR there to regenerate the affected snapshots. Before regenerating, confirm each change is *intended* Pandoc behavior and not a transient regression (a bad snapshot can freeze a bug — see [quarto-dev/quarto#944](https://github.com/quarto-dev/quarto/pull/944)). Cross-ref: [`cross-project-dependencies.md`](cross-project-dependencies.md).