Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add gradle deps example to unblock downstream docs build #36384

Merged
merged 1 commit into from
Oct 10, 2023

Conversation

rsvoboda
Copy link
Member

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 with TABS_REPLACEMENTS in https://github.com/quarkusio/quarkus/blob/main/docs/src/main/java/io/quarkus/docs/generation/AssembleDownstreamDocumentation.java#L322

tabReplacement.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 in TABS_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.

@quarkus-bot quarkus-bot bot added area/docstyle issues related for manual docstyle review area/documentation labels Oct 10, 2023
@gastaldi gastaldi merged commit d3a055f into quarkusio:main Oct 10, 2023
5 checks passed
@quarkus-bot quarkus-bot bot added this to the 3.5 - main milestone Oct 10, 2023
@github-actions
Copy link

github-actions bot commented Oct 10, 2023

🎊 PR Preview ee86174 has been successfully built and deployed to https://quarkus-pr-main-36384-preview.surge.sh/version/main/guides/

@sberyozkin
Copy link
Member

Thanks @rsvoboda

@inoxx03
Copy link

inoxx03 commented Oct 10, 2023

Thank you @rsvoboda !

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/docstyle issues related for manual docstyle review area/documentation kind/bugfix
Projects
Development

Successfully merging this pull request may close these issues.

PRs involving Doc updates are failing
4 participants