ci: enforce quarto extensions render only what they serve - #442
Closed
amylin1249 wants to merge 1 commit into
Closed
ci: enforce quarto extensions render only what they serve#442amylin1249 wants to merge 1 commit into
amylin1249 wants to merge 1 commit into
Conversation
Contributor
Extension release summary🚀 Will release on merge
😴 Changed but won't releaseThe following extensions have code changes but the manifest version hasn't been incremented:
If you intended to release these changes, update the See the contributing guide for details. |
amylin1249
force-pushed
the
ci-quarto-served-document-guard
branch
from
July 24, 2026 19:00
7166093 to
5edcc6d
Compare
amylin1249
marked this pull request as ready for review
July 24, 2026 19:08
dotNomad
reviewed
Jul 27, 2026
dotNomad
left a comment
dotNomad
left a comment
Collaborator
There was a problem hiding this comment.
I think all of the changes to the extensions here make a lot of sense, but the linting needs a bit more work. My suggestion would be just fix the extensions and come back to the linting in future work.
| _infra: | ||
| - integration/** | ||
| - .github/actions/connect-integration-test/** | ||
| - .github/actions/lint-extension/** |
Collaborator
There was a problem hiding this comment.
Should this be added to the complex-extension block too?
|
|
||
| # Without a _quarto.yml the directory is not a project, so Connect renders | ||
| # only the entrypoint and no sibling Markdown becomes a page. | ||
| if ! INSPECT=$(quarto inspect "$EXT_DIR" 2>/dev/null); then |
Collaborator
There was a problem hiding this comment.
Any quarto inspect failure will result in "not a Quarto project" so if the _quarto.yml is incorrect, like missing a semicolon in render: quarto inspect will error, but this will pass.
I think that this is tricky to do right though, maybe this is a good first pass that we improve over time.
| # A lone document is unambiguously the served document. Otherwise a | ||
| # rendered sibling Markdown file (Quarto ignores README.md) is a stray | ||
| # page that could become the served document. | ||
| STRAY_MD=$(grep -iE '\.md$' <<< "$INPUTS" | grep -viE '^README\.md$' || true) |
Collaborator
There was a problem hiding this comment.
This isn't checking for stray .qmd docs or other file types that Quarto can render.
|
|
||
| # Rendered input basenames. | ||
| INPUTS=$(jq -r '.files.input[] | split("/") | last' <<< "$INSPECT") | ||
| COUNT=$(grep -c . <<< "$INPUTS") |
Collaborator
There was a problem hiding this comment.
If there are no input matches I think this will exit 1 and fail.
This was referenced Jul 28, 2026
Contributor
Author
dotNomad
pushed a commit
that referenced
this pull request
Aug 14, 2026
Adds a lint-extension guard for Quarto content: it fails when a non-website extension renders more than one document, since with no pinned project.render the default served document can silently flip away from the entrypoint (#392) while every build-time check stays green. Addresses review feedback from #442: - Only skips the check when _quarto.yml is absent; an invalid _quarto.yml now fails quarto inspect loudly instead of passing. - Flags any stray rendered document (.qmd, .ipynb, etc.), not just Markdown. - Also retests complex extensions when the lint-extension action changes, matching the simple-extension _infra filter.
dotNomad
pushed a commit
that referenced
this pull request
Aug 14, 2026
Adds a lint-extension guard for Quarto content: it fails when a non-website extension renders more than one document, since with no pinned project.render the default served document can silently flip away from the entrypoint (#392) while every build-time check stays green. Addresses review feedback from #442: - Only skips the check when _quarto.yml is absent; an invalid _quarto.yml now fails quarto inspect loudly instead of passing. - Flags any stray rendered document (.qmd, .ipynb, etc.), not just Markdown. - Also retests complex extensions when the lint-extension action changes, matching the simple-extension _infra filter.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Fixes #403 -- adds a lint-extension guard that enforces the standard that a Quarto extension renders only the document it serves.
To make the existing content pass, this PR pins project.render to the entrypoint on quarto-stock-report-python, quarto-stock-report-r, and pqr (these ones rendered a stray CHANGELOG page).
As a part of the cleanup, this PR also deletes connect-extension.qmd from quarto-document and quarto-stock-report-python (this is a superseded legacy gallery-metadata file that now lives in the extension block of manifest.json).