Replace pre-release feature includes with version-aware shortcode#1964
Merged
Conversation
Rename _extensions/prerelease-docs-url/ to _extensions/prerelease/ and combine both shortcodes into a single Lua file with shared helpers: - prerelease-docs-url: existing shortcode for prerelease subdomain links - prerelease-callout: new shortcode that shows version-aware callouts for feature docs (hidden after release) and blog posts (switches from pre-release to released text)
Migrate 5 include references across 3 files (all version 1.5, already released) to use the new version-aware shortcode instead.
Migrate 5 blog posts to use {{< prerelease-callout X.Y type="blog" >}}
instead of including shared _quarto-X.Y-feature.qmd files.
These files are no longer needed now that the prerelease-callout shortcode generates callout content dynamically based on version.
Documents both shortcodes (prerelease-docs-url and prerelease-callout), usage examples, and version comparison logic with scenario table.
Contributor
Contributor
|
Backport failed for Please cherry-pick the changes locally and resolve any conflicts. git fetch origin prerelease
git worktree add -d .worktree/sync-1964-to-prerelease origin/prerelease
cd .worktree/sync-1964-to-prerelease
git switch --create sync-1964-to-prerelease
git cherry-pick -x d31a933349d70ece292d5461b5cac513cc3d02cc |
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
1 participant
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.
Port of #1961 (targeting
prerelease) tomain.Each release cycle requires manually editing per-version
_pre-release-feature.qmdinclude files (and corresponding blog post includes) to toggle pre-release callouts on and off. This is error-prone and adds steps to the release checklist.This replaces all
_pre-release-feature.qmdand_quarto-X.Y-feature.qmdincludes with aprerelease-calloutshortcode that reads the siteversionfrom_quarto.ymland automatically determines whether to show a callout:{{< prerelease-callout 1.5 >}} {{< prerelease-callout 1.9 type="blog" >}}The shortcode is added to the existing
_extensions/prerelease/extension (renamed fromprerelease-docs-url/) alongside the existingprerelease-docs-urlshortcode, sharing version-parsing helpers.Changes
_extensions/prerelease-docs-url/into_extensions/prerelease/with a singleprerelease.luacontaining both shortcodes_pre-release-feature.qmdincludes in docs and blog posts present onmainScope difference from #1961
Two files only exist on
prereleaseand are excluded here:docs/extensions/engine.qmddocs/publishing/posit-connect-cloud.qmdThese are already handled in #1961. When
prereleasemerges intomainat release time, they'll arrive already using the shortcode.