Auto inject extension status note if guides forget the include - #2892
Open
holly-cummins wants to merge 1 commit into
Open
Auto inject extension status note if guides forget the include#2892holly-cummins wants to merge 1 commit into
holly-cummins wants to merge 1 commit into
Conversation
This fixes broken fragment links where guides with extension-status labels link to #extension-status-note, but that anchor doesn't exist unless the guide manually includes extension-status.adoc. The solution injects the anchor programmatically at build time, requiring NO changes to the guides repository. Both Jekyll (Ruby) and Roq (Java) implementations prepend [[extension-status-note]] when converting the include file to HTML. Changes: 1. Ruby treeprocessor (_plugins/asciidoctor-extension.rb) - Detects when #extension-status-note anchor is missing - Reads _includes/extension-status.adoc - Prepends [[extension-status-note]] anchor before conversion - Converts to HTML with status attribute set - Inserts as pass block after the status label 2. Java Asciidoctor extensions (for Roq builds) - ExtensionStatusTreeprocessor: mirrors Ruby implementation - ConfigTableTreeprocessor: config table show more buttons - ConfigTablePostprocessor: config table CSS classes - TooltipInlineMacroProcessor: tooltip inline macro - EnvVarCopyButtonInlineMacroProcessor: env var copy buttons - ConfigPropertyCopyButtonInlineMacroProcessor: config property copy buttons - QuarkusExtensionRegistry: registers all extensions with Asciidoctor 3. Comprehensive test coverage (29 passing tests) - ExtensionStatusTreeprocessorTest: anchor injection behavior - ConfigTableTreeprocessorTest: config table processing - InlineMacroProcessorTest: all inline macro processors Key advantage: The extension-status.adoc files in the guides repo remain unchanged. No anchors need to be added there. The treeprocessors handle everything at build time. All Ruby plugins now have Java equivalents for Roq compatibility. Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
holly-cummins
force-pushed
the
auto-inject-extension-status-note
branch
from
August 4, 2026 16:59
7a51a97 to
4c27337
Compare
Status for workflow
|
|
🎊 PR Preview 01b114e has been successfully built and deployed to https://quarkus-website-pr-2892-preview.surge.sh
|
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
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.

#2713, our test for dead fragment links, can't be merged yet because some links are still dead:
I thought I'd fixed all the guides dead links with quarkusio/quarkus#55413, but when 3.38 was released, the latest guides were still failing.
Analysis suggested that some guides forget to include
extension-status.adoc, even though they put in an extension status. I could fix this in every guide with the problem, but that would be a lot of backports to get everything right. Instead, I've added some automagic, which auto-includes if an extension has a:extension-status:but doesn't include the adoc file.Magic does have drawbacks, so I'm happy if people push back and think we should fix at source.
Root Cause Analysis
Before July 13, 2026:
July 13, 2026 - PR 55413 merged:
[[extension-status-note]]anchor to extension-status.adoc in quarkus repoBut the problem persisted because:
set
August 3, 2026 - CI run failed:
August 4, 2026 - This PR
:extension-status:but doesn't include the file, the treeprocessor:a. Reads
_includes/extension-status.adocb. Prepends the anchor (semi-redundant + defensive, it's already in the file for the latest versions – but not for older ones)
c. Converts to HTML with the status attribute
d. Injects as a pass block