Add gradle deps example to unblock downstream docs build #36384
Merged
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.
Add gradle deps example to unblock downstream docs build
Fixes #36349
Details:
Docs build gets stuck on
security-oidc-code-flow-authentication.adoc
file when working withTABS_REPLACEMENTS
in https://github.com/quarkusio/quarkus/blob/main/docs/src/main/java/io/quarkus/docs/generation/AssembleDownstreamDocumentation.java#L322tabReplacement.getKey().matcher(rewrittenGuideWithoutTabs)
call gets stuck on pattern looking for xml and gradle example https://github.com/quarkusio/quarkus/blob/main/docs/src/main/java/io/quarkus/docs/generation/AssembleDownstreamDocumentation.java#L50 (first pattern defined inTABS_REPLACEMENTS
)security-oidc-code-flow-authentication.adoc
had one case where[source,xml,role="primary asciidoc-tabs-target-sync-cli asciidoc-tabs-target-sync-maven"]
was defined but[source,gradle,role="secondary asciidoc-tabs-target-sync-gradle"]
wasn't defined. And execution got stuck on this.I couldn't figure out how to detect this stuck situation in java code, thus I changed the problematic file.
tabReplacement.getKey().matcher(rewrittenGuideWithoutTabs).results().count();
is also stuck.Not sure what can be done to prevent this in the future, not super strong in matchers area, cc @gsmet
We could probably start listing files that are processed so we know where the build got stuck
Problematic change was introduced in #36175 and Documentation build failed after 6 hours on that PR.