AssembleDownstreamDocumentation - print guide name #36406

rsvoboda · 2023-10-11T11:06:43Z

AssembleDownstreamDocumentation - print guide name

Motivation: we had 2 issues with docs during 2 last days, this helps to identify which guide has issues.

sberyozkin · 2023-10-11T11:16:08Z

docs/src/main/java/io/quarkus/docs/generation/AssembleDownstreamDocumentation.java

@@ -124,6 +124,7 @@ public static void main(String[] args) throws Exception {
            Files.createDirectories(TARGET_ROOT_DIRECTORY);

            for (Path guide : guides) {
+                System.out.println("[INFO] Processing guide " + guide.getFileName());


Should LOG.infof be used instead ?

I had that in my initial version but the output is not nice, it is using JDK based logging which goes on 2 lines and is not aligned with the rest of output

[INFO] --- exec:3.0.0:exec (assemble-downstream-doc) @ quarkus-documentation --- [INFO] Processing guide datasource.adoc [INFO] Processing guide logging.adoc [INFO] Processing guide security-architecture.adoc [INFO] Processing guide security-authentication-mechanisms.adoc [INFO] Processing guide security-authorize-web-endpoints-reference.adoc [INFO] Processing guide security-basic-authentication-howto.adoc [INFO] Processing guide security-basic-authentication-tutorial.adoc [INFO] Processing guide security-basic-authentication.adoc [INFO] Processing guide security-identity-providers.adoc [INFO] Processing guide security-jpa.adoc [INFO] Processing guide security-oidc-bearer-token-authentication-tutorial.adoc [INFO] Processing guide security-oidc-bearer-token-authentication.adoc [INFO] Processing guide security-oidc-code-flow-authentication-tutorial.adoc [INFO] Processing guide security-oidc-code-flow-authentication.adoc [INFO] Processing guide security-oidc-configuration-properties-reference.adoc [INFO] Processing guide security-openid-connect-client-reference.adoc [INFO] Processing guide security-overview.adoc [INFO] Processing guide security-proactive-authentication.adoc Oct 11, 2023 1:16:34 PM io.quarkus.docs.generation.AssembleDownstreamDocumentation main INFO: Downstream documentation tree is available in: target/downstream-tree Oct 11, 2023 1:16:34 PM io.quarkus.docs.generation.AssembleDownstreamDocumentation main INFO: Downstream documentation listing is available in: target/downstream-files.txt [INFO] [INFO] --- asciidoctor:2.0.0:process-asciidoc (output-html) @ quarkus-documentation --- 2023-10-11T13:16:36.818+02:00 [main] WARN FilenoUtil : Native subprocess control requires open access to sun.nio.ch Pass '--add-opens java.base/sun.nio.ch=org.jruby.dist' or '=org.jruby.core' to enable. [INFO] Using 'UTF-8' encoding to copy filtered resources. [INFO] Copying 195 resources [INFO] Converted /Users/rsvoboda/tmp/quarkus/docs/target/asciidoc/sources/scripting.adoc [INFO] Converted /Users/rsvoboda/tmp/quarkus/docs/target/asciidoc/sources/kafka-dev-ui.adoc [INFO] Converted /Users/rsvoboda/tmp/quarkus/docs/target/asciidoc/sources/command-mode-reference.adoc [INFO] Converted /Users/rsvoboda/tmp/quarkus/docs/target/asciidoc/sources/grpc-xds.adoc [INFO] Converted /Users/rsvoboda/tmp/quarkus/docs/target/asciidoc/sources/picocli.adoc [INFO] Converted /Users/rsvoboda/tmp/quarkus/docs/target/asciidoc/sources/security-webauthn.adoc [INFO] Converted /Users/rsvoboda/tmp/quarkus/docs/target/asciidoc/sources/deploying-to-google-cloud.adoc [INFO] Converted /Users/rsvoboda/tmp/quarkus/docs/target/asciidoc/sources/tooling.adoc [INFO] Converted /Users/rsvoboda/tmp/quarkus/docs/target/asciidoc/sources/dev-ui-v2.adoc [INFO] Converted /Users/rsvoboda/tmp/quarkus/docs/target/asciidoc/sources/aws-lambda-snapstart.adoc [INFO] Converted /Users/rsvoboda/tmp/quarkus/docs/target/asciidoc/sources/elasticsearch.adoc [INFO] Converted /Users/rsvoboda/tmp/quarkus/docs/target/asciidoc/sources/logging.adoc [INFO] Converted /Users/rsvoboda/tmp/quarkus/docs/target/asciidoc/sources/http-reference.adoc [INFO] Converted /Users/rsvoboda/tmp/quarkus/docs/target/asciidoc/sources/writing-native-applications-tips.adoc [INFO] Converted /Users/rsvoboda/tmp/quarkus/docs/target/asciidoc/sources/dev-services.adoc [INFO] Converted /Users/rsvoboda/tmp/quarkus/docs/target/asciidoc/sources/building-my-first-extension.adoc [INFO] Converted /Users/rsvoboda/tmp/quarkus/docs/target/asciidoc/sources/datasource.adoc [INFO] Converted /Users/rsvoboda/tmp/quarkus/docs/target/asciidoc/sources/getting-started-testing.adoc [INFO] Converted /Users/rsvoboda/tmp/quarkus/docs/target/asciidoc/sources/transaction.adoc [INFO] Converted /Users/rsvoboda/tmp/quarkus/docs/target/asciidoc/sources/config-yaml.adoc [INFO] Converted /Users/rsvoboda/tmp/quarkus/docs/target/asciidoc/sources/azure-functions.adoc [INFO] Converted /Users/rsvoboda/tmp/quarkus/docs/target/asciidoc/sources/vertx-reference.adoc [INFO] Converted /Users/rsvoboda/tmp/quarkus/docs/target/asciidoc/sources/smallrye-fault-tolerance.adoc [INFO] Converted /Users/rsvoboda/tmp/quarkus/docs/target/asciidoc/sources/funqy-azure-functions-http.adoc [INFO] Converted /Users/rsvoboda/tmp/quarkus/docs/target/asciidoc/sources/hibernate-orm-panache-kotlin.adoc [INFO] Converted /Users/rsvoboda/tmp/quarkus/docs/target/asciidoc/sources/security-proactive-authentication.adoc [INFO] Converted /Users/rsvoboda/tmp/quarkus/docs/target/asciidoc/sources/mutiny-primer.adoc [INFO] Converted /Users/rsvoboda/tmp/quarkus/docs/target/asciidoc/sources/kafka.adoc [INFO] Converted /Users/rsvoboda/tmp/quarkus/docs/target/asciidoc/sources/kubernetes-config.adoc [INFO] Converted /Users/rsvoboda/tmp/quarkus/docs/target/asciidoc/sources/hibernate-reactive.adoc [INFO] Converted /Users/rsvoboda/tmp/quarkus/docs/target/asciidoc/sources/qute.adoc [INFO] Converted /Users/rsvoboda/tmp/quarkus/docs/target/asciidoc/sources/maven-tooling.adoc [INFO] Converted /Users/rsvoboda/tmp/quarkus/docs/target/asciidoc/sources/pulsar-getting-started.adoc [INFO] Converted /Users/rsvoboda/tmp/quarkus/docs/target/asciidoc/sources/security-jwt-build.adoc [INFO] Converted /Users/rsvoboda/tmp/quarkus/docs/target/asciidoc/sources/deploying-to-azure-cloud.adoc [INFO] Converted /Users/rsvoboda/tmp/quarkus/docs/target/asciidoc/sources/init-tasks.adoc [INFO] Converted /Users/rsvoboda/tmp/quarkus/docs/target/asciidoc/sources/hibernate-search-orm-elasticsearch.adoc [INFO] Converted /Users/rsvoboda/tmp/quarkus/docs/target/asciidoc/sources/mongodb.adoc [INFO] Converted /Users/rsvoboda/tmp/quarkus/docs/target/asciidoc/sources/jreleaser.adoc [INFO] Converted /Users/rsvoboda/tmp/quarkus/docs/target/asciidoc/sources/kafka-schema-registry-avro.adoc [INFO] Converted /Users/rsvoboda/tmp/quarkus/docs/target/asciidoc/sources/spring-cache.adoc [INFO] Converted /Users/rsvoboda/tmp/quarkus/docs/target/asciidoc/sources/build-analytics.adoc [INFO] Converted /Users/rsvoboda/tmp/quarkus/docs/target/asciidoc/sources/security-identity-providers.adoc [INFO] Converted /Users/rsvoboda/tmp/quarkus/docs/target/asciidoc/sources/security-openid-connect-client.adoc [INFO] Converted /Users/rsvoboda/tmp/quarkus/docs/target/asciidoc/sources/jms.adoc [INFO] Converted /Users/rsvoboda/tmp/quarkus/docs/target/asciidoc/sources/lra.adoc [INFO] Converted /Users/rsvoboda/tmp/quarkus/docs/target/asciidoc/sources/security-vulnerability-detection.adoc [INFO] Converted /Users/rsvoboda/tmp/quarkus/docs/target/asciidoc/sources/spring-boot-properties.adoc [INFO] Converted /Users/rsvoboda/tmp/quarkus/docs/target/asciidoc/sources/spring-cloud-config-client.adoc [INFO] Converted /Users/rsvoboda/tmp/quarkus/docs/target/asciidoc/sources/security-testing.adoc [INFO] Converted /Users/rsvoboda/tmp/quarkus/docs/target/asciidoc/sources/blaze-persistence.adoc [INFO] Converted /Users/rsvoboda/tmp/quarkus/docs/target/asciidoc/sources/capabilities.adoc [INFO] Converted /Users/rsvoboda/tmp/quarkus/docs/target/asciidoc/sources/quarkus-reactive-architecture.adoc [INFO] Converted /Users/rsvoboda/tmp/quarkus/docs/target/asciidoc/sources/opentelemetry.adoc [INFO] Converted /Users/rsvoboda/tmp/quarkus/docs/target/asciidoc/sources/resteasy-reactive-migration.adoc [INFO] Converted /Users/rsvoboda/tmp/quarkus/docs/target/asciidoc/sources/grpc-service-consumption.adoc [INFO] Converted /Users/rsvoboda/tmp/quarkus/docs/target/asciidoc/sources/funqy-http.adoc [INFO] Converted /Users/rsvoboda/tmp/quarkus/docs/target/asciidoc/sources/spring-scheduled.adoc [INFO] Converted /Users/rsvoboda/tmp/quarkus/docs/target/asciidoc/sources/centralized-log-management.adoc [INFO] Converted /Users/rsvoboda/tmp/quarkus/docs/target/asciidoc/sources/conditional-extension-dependencies.adoc [INFO] Converted /Users/rsvoboda/tmp/quarkus/docs/target/asciidoc/sources/native-reference.adoc [INFO] Converted /Users/rsvoboda/tmp/quarkus/docs/target/asciidoc/sources/aws-lambda-http.adoc [INFO] Converted /Users/rsvoboda/tmp/quarkus/docs/target/asciidoc/sources/azure-functions-http.adoc [INFO] Converted /Users/rsvoboda/tmp/quarkus/docs/target/asciidoc/sources/quarkus-maven-plugin.adoc [INFO] Converted /Users/rsvoboda/tmp/quarkus/docs/target/asciidoc/sources/flyway.adoc [INFO] Converted /Users/rsvoboda/tmp/quarkus/docs/target/asciidoc/sources/all-builditems.adoc ...

Thesame approach is used on many places in docs module

~/git/quarkus/docs    print.guide.name  git grep 'System.out.println("\[' src/main/java/io/quarkus/docs/generation/AssembleDownstreamDocumentation.java: System.out.println("[INFO] Processing guide " + guide.getFileName()); src/main/java/io/quarkus/docs/generation/CopyExampleSource.java: System.out.println("[INFO] Output directory: " + copyExamples.outputPath); src/main/java/io/quarkus/docs/generation/CopyExampleSource.java: System.out.println("[INFO] Project root: " + copyExamples.rootPath); src/main/java/io/quarkus/docs/generation/CopyExampleSource.java: System.out.println("[INFO] Reading: " + path); src/main/java/io/quarkus/docs/generation/ReferenceIndexGenerator.java: System.out.println("[INFO] Creating reference index generator: " + List.of(args)); src/main/java/io/quarkus/docs/generation/ReferenceIndexGenerator.java: System.out.println("[INFO] Generating reference index"); src/main/java/io/quarkus/docs/generation/ReferenceIndexGenerator.java: System.out.println("[INFO] Writing reference index file"); src/main/java/io/quarkus/docs/generation/ReferenceIndexGenerator.java: System.out.println("[INFO] Transforming the source code"); src/main/java/io/quarkus/docs/generation/ReferenceIndexGenerator.java: System.out.println("[INFO] Done"); src/main/java/io/quarkus/docs/generation/YamlMetadataGenerator.java: System.out.println("[INFO] Creating YAML metadata generator: " + List.of(args)); src/main/java/io/quarkus/docs/generation/YamlMetadataGenerator.java: System.out.println("[INFO] Generating metadata index"); src/main/java/io/quarkus/docs/generation/YamlMetadataGenerator.java: System.out.println("[INFO] Writing metadata index and error files"); src/main/java/io/quarkus/docs/generation/YamlMetadataGenerator.java: System.out.println("[INFO] Done");

quarkus-bot · 2023-10-11T11:35:09Z

✔️ The latest workflow run for the pull request has completed successfully.

It should be safe to merge provided you have a look at the other checks in the summary.

gsmet · 2023-10-11T11:42:54Z

As for the original problem, I barely translated to Java a bash script that was provided to me, as far as the regexps are concerned.

I have no idea what could make it stuck, tbh. Getting a thread dump might help to understand the problem.

rsvoboda · 2023-10-11T15:50:47Z

@gsmet here is stuck-docs-thread-dump.txt

I dropped #36384 changes and executed mvn clean package -pl docs -DskipTests.
When the build got stuck I hit Ctrl+\.

gsmet · 2023-10-11T15:55:15Z

OK so my guess is that somehow the regexp is running forever (or is extremely slow when the finishing part of the regexp is not around).

…

On Wed, Oct 11, 2023 at 5:50 PM Rostislav Svoboda ***@***.***> wrote: @gsmet <https://github.com/gsmet> here is stuck-docs-thread-dump.txt <https://github.com/quarkusio/quarkus/files/12872005/stuck-docs-thread-dump.txt> I dropped #36384 <#36384> changes and executed mvn clean package -pl docs -DskipTests. When the build got stuck I hit Ctrl+\. — Reply to this email directly, view it on GitHub <#36406 (comment)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/AAJYOBI5W6BJ4RISSSK4M33X6256FANCNFSM6AAAAAA53ZYGGI> . You are receiving this because you were mentioned.Message ID: ***@***.***>

rsvoboda · 2023-10-11T16:10:09Z

Yeah, java.util.regex.Pattern part is long and looks like cycling in a loop.
For example at java.util.regex.Pattern$CharPropertyGreedy.match([email protected]/Pattern.java:4290) is there many times

This MR contains the following updates: | Package | Type | Update | Change | |---|---|---|---| | [flow-bin](https://github.com/flowtype/flow-bin) ([changelog](https://github.com/facebook/flow/blob/master/Changelog.md)) | devDependencies | minor | [`^0.219.0` -> `^0.220.0`](https://renovatebot.com/diffs/npm/flow-bin/0.219.0/0.220.0) | | [org.jsoup:jsoup](https://jsoup.org/) ([source](https://github.com/jhy/jsoup)) | compile | patch | `1.16.1` -> `1.16.2` | | [io.quarkus:quarkus-maven-plugin](https://github.com/quarkusio/quarkus) | build | minor | `3.4.3` -> `3.5.0` | | [io.quarkus:quarkus-universe-bom](https://github.com/quarkusio/quarkus-platform) | import | minor | `3.4.3` -> `3.5.0` | --- ### Release Notes <details> <summary>flowtype/flow-bin</summary> ### [`v0.220.0`](flow/flow-bin@f7f3f3f...030bfc6) [Compare Source](flow/flow-bin@f7f3f3f...030bfc6) ### [`v0.219.5`](flow/flow-bin@f16a6c7...f7f3f3f) [Compare Source](flow/flow-bin@f16a6c7...f7f3f3f) ### [`v0.219.4`](flow/flow-bin@9f67075...f16a6c7) [Compare Source](flow/flow-bin@9f67075...f16a6c7) ### [`v0.219.3`](flow/flow-bin@80dcea5...9f67075) [Compare Source](flow/flow-bin@80dcea5...9f67075) ### [`v0.219.2`](flow/flow-bin@c184c5d...80dcea5) [Compare Source](flow/flow-bin@c184c5d...80dcea5) </details> <details> <summary>quarkusio/quarkus</summary> ### [`v3.5.0`](https://github.com/quarkusio/quarkus/releases/tag/3.5.0) [Compare Source](quarkusio/quarkus@3.4.3...3.5.0) ##### Complete changelog - [#36527](quarkusio/quarkus#36527) - Start MongoDB 4.4 instead of 4.0 - [#36523](quarkusio/quarkus#36523) - Minor OIDC Auth0 updates - [#36518](quarkusio/quarkus#36518) - Allow for setting logging scope programmatically - [#36517](quarkusio/quarkus#36517) - Use Mandrel 23.1 in windows CI - [#36501](quarkusio/quarkus#36501) - Let custom OIDC token propagation filters customize the exchange status - [#36495](quarkusio/quarkus#36495) - Support external OTel exporters in CDI - [#36490](quarkusio/quarkus#36490) - Take ReaderInterceptor into account when reading SSE events - [#36487](quarkusio/quarkus#36487) - Upgrade to Liquibase 4.24.0 - [#36485](quarkusio/quarkus#36485) - Fix typo in gradle-tooling.adoc - [#36474](quarkusio/quarkus#36474) - Fix some issues in getting-started-dev-services - [#36465](quarkusio/quarkus#36465) - Be more consistent in guides when creating projects/adding extensions - [#36464](quarkusio/quarkus#36464) - HTTP reference guide - HTTP/2 section update, drop JDK 8 note - [#36459](quarkusio/quarkus#36459) - Let custom OIDC token propagation filters provide client name - [#36457](quarkusio/quarkus#36457) - Update builder images to jdk-21 - [#36453](quarkusio/quarkus#36453) - Upgrade Oracle JDBC driver to 23.3.0.23.09 - [#36452](quarkusio/quarkus#36452) - Fix doc extension-add.adoc - [#36451](quarkusio/quarkus#36451) - Adjust extension name for consistency with rest of Quarkus - [#36446](quarkusio/quarkus#36446) - Regression: Liquibase fails to migrate on Quarkus start, crashing the application - [#36445](quarkusio/quarkus#36445) - Updates to Infinispan 14.0.19.Final - [#36442](quarkusio/quarkus#36442) - Use default content type when X-SSE header not set - [#36436](quarkusio/quarkus#36436) - Upgrade to Hibernate ORM 6.2.13.Final - [#36432](quarkusio/quarkus#36432) - Hibernate Reactive Panache: improve error message - [#36420](quarkusio/quarkus#36420) - Allow parallel execution of blocking health checks - [#36419](quarkusio/quarkus#36419) - Blocking Health Checks should be executed in parallel, not sequentially/ordered - [#36417](quarkusio/quarkus#36417) - Reduce timeout of the doc build to 60 minutes - [#36413](quarkusio/quarkus#36413) - Simplify virtual threads guide by pushing users to 21 - [#36412](quarkusio/quarkus#36412) - Drop Optaplanner from the documentation - [#36411](quarkusio/quarkus#36411) - Drop panache topic from Hibernate Reactive guide - [#36410](quarkusio/quarkus#36410) - Add compatibility topic to Spring guides - [#36407](quarkusio/quarkus#36407) - Register RuntimeOverrideConfigSource in STATIC_INIT - [#36406](quarkusio/quarkus#36406) - AssembleDownstreamDocumentation - print guide name - [#36400](quarkusio/quarkus#36400) - Add topics and extensions metadata to guides - [#36367](quarkusio/quarkus#36367) - Bump org.wiremock:wiremock-standalone from 3.1.0 to 3.2.0 - [#36365](quarkusio/quarkus#36365) - Bump de.flapdoodle.embed:de.flapdoodle.embed.mongo from 4.7.0 to 4.9.2 - [#36360](quarkusio/quarkus#36360) - Drop the old Dev UI guide - [#36337](quarkusio/quarkus#36337) - Upgrade maven to version 3.9.5 - [#36236](quarkusio/quarkus#36236) - No Panache session in REST endpoints defined by an interface - [#35931](quarkusio/quarkus#35931) - Add OIDC Auth0 extended tutorial - [#33548](quarkusio/quarkus#33548) - Pick random debug port when the configured one is taken - [#33363](quarkusio/quarkus#33363) - allow quarkus dev to pick random debug port </details> <details> <summary>quarkusio/quarkus-platform</summary> ### [`v3.5.0`](quarkusio/quarkus-platform@3.4.3...3.5.0) [Compare Source](quarkusio/quarkus-platform@3.4.3...3.5.0) </details> --- ### Configuration 📅 **Schedule**: Branch creation - At any time (no schedule defined), Automerge - At any time (no schedule defined). 🚦 **Automerge**: Enabled. ♻ **Rebasing**: Whenever MR is behind base branch, or you tick the rebase/retry checkbox. 👻 **Immortal**: This MR will be recreated if closed unmerged. Get [config help](https://github.com/renovatebot/renovate/discussions) if that's undesired. --- - [ ] If you want to rebase/retry this MR, check this box --- This MR has been generated by [Renovate Bot](https://github.com/renovatebot/renovate).

Print guide name

d61e3e3

quarkus-bot bot added the area/documentation label Oct 11, 2023

sberyozkin reviewed Oct 11, 2023

View reviewed changes

rsvoboda requested a review from sberyozkin October 11, 2023 11:29

gsmet approved these changes Oct 11, 2023

View reviewed changes

gsmet merged commit 429a9ef into quarkusio:main Oct 11, 2023
19 checks passed

quarkus-bot bot added this to the 3.6 - main milestone Oct 11, 2023

gsmet added triage/backport? triage/backport-3.2 labels Oct 17, 2023

gsmet modified the milestones: 3.6 - main, 3.5.0 Oct 17, 2023

gsmet removed the triage/backport? label Oct 17, 2023

aloubyansky modified the milestones: 3.5.0, 3.2.8.Final Oct 25, 2023

aloubyansky removed the triage/backport-3.2 label Oct 25, 2023

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

AssembleDownstreamDocumentation - print guide name #36406

AssembleDownstreamDocumentation - print guide name #36406

rsvoboda commented Oct 11, 2023 •

edited

Loading

sberyozkin Oct 11, 2023

rsvoboda Oct 11, 2023

rsvoboda Oct 11, 2023

quarkus-bot bot commented Oct 11, 2023

gsmet commented Oct 11, 2023

rsvoboda commented Oct 11, 2023

gsmet commented Oct 11, 2023 via email

rsvoboda commented Oct 11, 2023 •

edited

Loading

AssembleDownstreamDocumentation - print guide name #36406

AssembleDownstreamDocumentation - print guide name #36406

Conversation

rsvoboda commented Oct 11, 2023 • edited Loading

sberyozkin Oct 11, 2023

Choose a reason for hiding this comment

rsvoboda Oct 11, 2023

Choose a reason for hiding this comment

rsvoboda Oct 11, 2023

Choose a reason for hiding this comment

quarkus-bot bot commented Oct 11, 2023

gsmet commented Oct 11, 2023

rsvoboda commented Oct 11, 2023

gsmet commented Oct 11, 2023 via email

rsvoboda commented Oct 11, 2023 • edited Loading

rsvoboda commented Oct 11, 2023 •

edited

Loading

rsvoboda commented Oct 11, 2023 •

edited

Loading