search

KhronosGroup / Vulkan-Samples

One stop solution for all Vulkan samples
Apache License 2.0
4.33k stars 648 forks source link

Detect common errors that affect Antora #1000

Closed oddhack closed 6 months ago

oddhack commented 7 months ago

Per #999, a recently added sample caused some errors in the Vulkan-Site Antora build. Unfortunately it is difficult to close the loop and have a CI error there automatically feed back directly to the underlying repo of the component causing problems.

Given the nature of the problems (one put an Antora-specific ifdefed section before the introductory section markup, another neglected to use the asciidoc attribute that would cause the xref to work in Antora), it seems relatively likely they would recur with new components. Perhaps the CI tooling could look for this - for reference the errors Antora generated looked like

[00:04:10.210] ERROR (asciidoctor): target of xref not found: ./performance/image_compression_control/README.adoc
    file: /home/tree/git/Vulkan-Site/Vulkan-Samples/antora/modules/ROOT/pages/samples/performance/README.adoc
    source: /home/tree/git/Vulkan-Site/Vulkan-Samples (branch: main <worktree> | start path: antora)
[00:04:11.700] ERROR (asciidoctor): level 0 sections can only be used when doctype is book
    file: /home/tree/git/Vulkan-Site/Vulkan-Samples/antora/modules/ROOT/pages/samples/performance/image_compression_control/README.adoc:29
    source: /home/tree/git/Vulkan-Site/Vulkan-Samples (branch: main <worktree> | start path: antora)
oddhack commented 6 months ago

Closing as a duplicate (really, a subset of) #1040