Skip to content

chore: prevent asciidoctor warnings when building documentation #1629

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.

Sign up for GitHub

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

Jump to bottom
Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

chore: prevent asciidoctor warnings when building documentation #1629

wants to merge 1 commit into from

Conversation

oemebamo
Copy link
Contributor

@oemebamo oemebamo commented Jun 5, 2025

When building the docs for this repository, asciidoctor gives a couple of warnings. This PR fixes those warnings.

Most of them are forgotten escaping for {variables} and then a couple of places where blocks weren't ended properly.

Before:

@timefoldai/docs:dev: [17:11:01.614] WARN (asciidoctor): skipping reference to missing attribute: property_prefix
@timefoldai/docs:dev:     file: /Users/jurriaanpersyn/Documents/GitHub/timefold-solver/docs/src/modules/ROOT/pages/integration/config-properties.adoc
@timefoldai/docs:dev:     source: /Users/jurriaanpersyn/Documents/GitHub/timefold-solver (branch: main <worktree> | start path: docs/src)
@timefoldai/docs:dev: [17:11:01.615] WARN (asciidoctor): skipping reference to missing attribute: property_prefix
@timefoldai/docs:dev:     file: /Users/jurriaanpersyn/Documents/GitHub/timefold-solver/docs/src/modules/ROOT/pages/integration/config-properties.adoc
@timefoldai/docs:dev:     source: /Users/jurriaanpersyn/Documents/GitHub/timefold-solver (branch: main <worktree> | start path: docs/src)
@timefoldai/docs:dev: [17:11:01.615] WARN (asciidoctor): skipping reference to missing attribute: solver_name_prefix
@timefoldai/docs:dev:     file: /Users/jurriaanpersyn/Documents/GitHub/timefold-solver/docs/src/modules/ROOT/pages/integration/config-properties.adoc
@timefoldai/docs:dev:     source: /Users/jurriaanpersyn/Documents/GitHub/timefold-solver (branch: main <worktree> | start path: docs/src)
@timefoldai/docs:dev: [17:11:01.615] WARN (asciidoctor): skipping reference to missing attribute: property_prefix
@timefoldai/docs:dev:     file: /Users/jurriaanpersyn/Documents/GitHub/timefold-solver/docs/src/modules/ROOT/pages/integration/config-properties.adoc
@timefoldai/docs:dev:     source: /Users/jurriaanpersyn/Documents/GitHub/timefold-solver (branch: main <worktree> | start path: docs/src)
@timefoldai/docs:dev: [17:11:01.616] WARN (asciidoctor): skipping reference to missing attribute: solver_name_prefix
@timefoldai/docs:dev:     file: /Users/jurriaanpersyn/Documents/GitHub/timefold-solver/docs/src/modules/ROOT/pages/integration/config-properties.adoc
@timefoldai/docs:dev:     source: /Users/jurriaanpersyn/Documents/GitHub/timefold-solver (branch: main <worktree> | start path: docs/src)
@timefoldai/docs:dev: [17:11:01.616] WARN (asciidoctor): skipping reference to missing attribute: property_prefix
@timefoldai/docs:dev:     file: /Users/jurriaanpersyn/Documents/GitHub/timefold-solver/docs/src/modules/ROOT/pages/integration/config-properties.adoc
@timefoldai/docs:dev:     source: /Users/jurriaanpersyn/Documents/GitHub/timefold-solver (branch: main <worktree> | start path: docs/src)
@timefoldai/docs:dev: [17:11:01.616] WARN (asciidoctor): skipping reference to missing attribute: solver_name_prefix
@timefoldai/docs:dev:     file: /Users/jurriaanpersyn/Documents/GitHub/timefold-solver/docs/src/modules/ROOT/pages/integration/config-properties.adoc
@timefoldai/docs:dev:     source: /Users/jurriaanpersyn/Documents/GitHub/timefold-solver (branch: main <worktree> | start path: docs/src)
@timefoldai/docs:dev: [17:11:01.616] WARN (asciidoctor): skipping reference to missing attribute: property_prefix
@timefoldai/docs:dev:     file: /Users/jurriaanpersyn/Documents/GitHub/timefold-solver/docs/src/modules/ROOT/pages/integration/config-properties.adoc
@timefoldai/docs:dev:     source: /Users/jurriaanpersyn/Documents/GitHub/timefold-solver (branch: main <worktree> | start path: docs/src)
@timefoldai/docs:dev: [17:11:01.617] WARN (asciidoctor): skipping reference to missing attribute: solver_name_prefix
@timefoldai/docs:dev:     file: /Users/jurriaanpersyn/Documents/GitHub/timefold-solver/docs/src/modules/ROOT/pages/integration/config-properties.adoc
@timefoldai/docs:dev:     source: /Users/jurriaanpersyn/Documents/GitHub/timefold-solver (branch: main <worktree> | start path: docs/src)
@timefoldai/docs:dev: [17:11:01.617] WARN (asciidoctor): skipping reference to missing attribute: property_prefix
@timefoldai/docs:dev:     file: /Users/jurriaanpersyn/Documents/GitHub/timefold-solver/docs/src/modules/ROOT/pages/integration/config-properties.adoc
@timefoldai/docs:dev:     source: /Users/jurriaanpersyn/Documents/GitHub/timefold-solver (branch: main <worktree> | start path: docs/src)
@timefoldai/docs:dev: [17:11:01.618] WARN (asciidoctor): skipping reference to missing attribute: solver_name_prefix
@timefoldai/docs:dev:     file: /Users/jurriaanpersyn/Documents/GitHub/timefold-solver/docs/src/modules/ROOT/pages/integration/config-properties.adoc
@timefoldai/docs:dev:     source: /Users/jurriaanpersyn/Documents/GitHub/timefold-solver (branch: main <worktree> | start path: docs/src)
@timefoldai/docs:dev: [17:11:01.618] WARN (asciidoctor): skipping reference to missing attribute: property_prefix
@timefoldai/docs:dev:     file: /Users/jurriaanpersyn/Documents/GitHub/timefold-solver/docs/src/modules/ROOT/pages/integration/config-properties.adoc
@timefoldai/docs:dev:     source: /Users/jurriaanpersyn/Documents/GitHub/timefold-solver (branch: main <worktree> | start path: docs/src)
@timefoldai/docs:dev: [17:11:01.618] WARN (asciidoctor): skipping reference to missing attribute: solver_name_prefix
@timefoldai/docs:dev:     file: /Users/jurriaanpersyn/Documents/GitHub/timefold-solver/docs/src/modules/ROOT/pages/integration/config-properties.adoc
@timefoldai/docs:dev:     source: /Users/jurriaanpersyn/Documents/GitHub/timefold-solver (branch: main <worktree> | start path: docs/src)
@timefoldai/docs:dev: [17:11:01.618] WARN (asciidoctor): skipping reference to missing attribute: property_prefix
@timefoldai/docs:dev:     file: /Users/jurriaanpersyn/Documents/GitHub/timefold-solver/docs/src/modules/ROOT/pages/integration/config-properties.adoc
@timefoldai/docs:dev:     source: /Users/jurriaanpersyn/Documents/GitHub/timefold-solver (branch: main <worktree> | start path: docs/src)
@timefoldai/docs:dev: [17:11:01.618] WARN (asciidoctor): skipping reference to missing attribute: solver_name_prefix
@timefoldai/docs:dev:     file: /Users/jurriaanpersyn/Documents/GitHub/timefold-solver/docs/src/modules/ROOT/pages/integration/config-properties.adoc
@timefoldai/docs:dev:     source: /Users/jurriaanpersyn/Documents/GitHub/timefold-solver (branch: main <worktree> | start path: docs/src)
@timefoldai/docs:dev: [17:11:01.618] WARN (asciidoctor): skipping reference to missing attribute: property_prefix
@timefoldai/docs:dev:     file: /Users/jurriaanpersyn/Documents/GitHub/timefold-solver/docs/src/modules/ROOT/pages/integration/config-properties.adoc
@timefoldai/docs:dev:     source: /Users/jurriaanpersyn/Documents/GitHub/timefold-solver (branch: main <worktree> | start path: docs/src)
@timefoldai/docs:dev: [17:11:01.618] WARN (asciidoctor): skipping reference to missing attribute: solver_name_prefix
@timefoldai/docs:dev:     file: /Users/jurriaanpersyn/Documents/GitHub/timefold-solver/docs/src/modules/ROOT/pages/integration/config-properties.adoc
@timefoldai/docs:dev:     source: /Users/jurriaanpersyn/Documents/GitHub/timefold-solver (branch: main <worktree> | start path: docs/src)
@timefoldai/docs:dev: [17:11:01.619] WARN (asciidoctor): skipping reference to missing attribute: property_prefix
@timefoldai/docs:dev:     file: /Users/jurriaanpersyn/Documents/GitHub/timefold-solver/docs/src/modules/ROOT/pages/integration/config-properties.adoc
@timefoldai/docs:dev:     source: /Users/jurriaanpersyn/Documents/GitHub/timefold-solver (branch: main <worktree> | start path: docs/src)
@timefoldai/docs:dev: [17:11:01.619] WARN (asciidoctor): skipping reference to missing attribute: solver_name_prefix
@timefoldai/docs:dev:     file: /Users/jurriaanpersyn/Documents/GitHub/timefold-solver/docs/src/modules/ROOT/pages/integration/config-properties.adoc
@timefoldai/docs:dev:     source: /Users/jurriaanpersyn/Documents/GitHub/timefold-solver (branch: main <worktree> | start path: docs/src)
@timefoldai/docs:dev: [17:11:01.619] WARN (asciidoctor): skipping reference to missing attribute: property_prefix
@timefoldai/docs:dev:     file: /Users/jurriaanpersyn/Documents/GitHub/timefold-solver/docs/src/modules/ROOT/pages/integration/config-properties.adoc
@timefoldai/docs:dev:     source: /Users/jurriaanpersyn/Documents/GitHub/timefold-solver (branch: main <worktree> | start path: docs/src)
@timefoldai/docs:dev: [17:11:01.619] WARN (asciidoctor): skipping reference to missing attribute: solver_name_prefix
@timefoldai/docs:dev:     file: /Users/jurriaanpersyn/Documents/GitHub/timefold-solver/docs/src/modules/ROOT/pages/integration/config-properties.adoc
@timefoldai/docs:dev:     source: /Users/jurriaanpersyn/Documents/GitHub/timefold-solver (branch: main <worktree> | start path: docs/src)
@timefoldai/docs:dev: [17:11:01.619] WARN (asciidoctor): skipping reference to missing attribute: property_prefix
@timefoldai/docs:dev:     file: /Users/jurriaanpersyn/Documents/GitHub/timefold-solver/docs/src/modules/ROOT/pages/integration/config-properties.adoc
@timefoldai/docs:dev:     source: /Users/jurriaanpersyn/Documents/GitHub/timefold-solver (branch: main <worktree> | start path: docs/src)
@timefoldai/docs:dev: [17:11:01.619] WARN (asciidoctor): skipping reference to missing attribute: solver_name_prefix
@timefoldai/docs:dev:     file: /Users/jurriaanpersyn/Documents/GitHub/timefold-solver/docs/src/modules/ROOT/pages/integration/config-properties.adoc
@timefoldai/docs:dev:     source: /Users/jurriaanpersyn/Documents/GitHub/timefold-solver (branch: main <worktree> | start path: docs/src)
@timefoldai/docs:dev: [17:11:01.619] WARN (asciidoctor): skipping reference to missing attribute: property_prefix
@timefoldai/docs:dev:     file: /Users/jurriaanpersyn/Documents/GitHub/timefold-solver/docs/src/modules/ROOT/pages/integration/config-properties.adoc
@timefoldai/docs:dev:     source: /Users/jurriaanpersyn/Documents/GitHub/timefold-solver (branch: main <worktree> | start path: docs/src)
@timefoldai/docs:dev: [17:11:01.619] WARN (asciidoctor): skipping reference to missing attribute: solver_name_prefix
@timefoldai/docs:dev:     file: /Users/jurriaanpersyn/Documents/GitHub/timefold-solver/docs/src/modules/ROOT/pages/integration/config-properties.adoc
@timefoldai/docs:dev:     source: /Users/jurriaanpersyn/Documents/GitHub/timefold-solver (branch: main <worktree> | start path: docs/src)
@timefoldai/docs:dev: [17:11:01.620] WARN (asciidoctor): skipping reference to missing attribute: property_prefix
@timefoldai/docs:dev:     file: /Users/jurriaanpersyn/Documents/GitHub/timefold-solver/docs/src/modules/ROOT/pages/integration/config-properties.adoc
@timefoldai/docs:dev:     source: /Users/jurriaanpersyn/Documents/GitHub/timefold-solver (branch: main <worktree> | start path: docs/src)
@timefoldai/docs:dev: [17:11:01.620] WARN (asciidoctor): skipping reference to missing attribute: solver_name_prefix
@timefoldai/docs:dev:     file: /Users/jurriaanpersyn/Documents/GitHub/timefold-solver/docs/src/modules/ROOT/pages/integration/config-properties.adoc
@timefoldai/docs:dev:     source: /Users/jurriaanpersyn/Documents/GitHub/timefold-solver (branch: main <worktree> | start path: docs/src)
@timefoldai/docs:dev: [17:11:01.620] WARN (asciidoctor): skipping reference to missing attribute: property_prefix
@timefoldai/docs:dev:     file: /Users/jurriaanpersyn/Documents/GitHub/timefold-solver/docs/src/modules/ROOT/pages/integration/config-properties.adoc
@timefoldai/docs:dev:     source: /Users/jurriaanpersyn/Documents/GitHub/timefold-solver (branch: main <worktree> | start path: docs/src)
@timefoldai/docs:dev: [17:11:01.620] WARN (asciidoctor): skipping reference to missing attribute: solver_name_prefix
@timefoldai/docs:dev:     file: /Users/jurriaanpersyn/Documents/GitHub/timefold-solver/docs/src/modules/ROOT/pages/integration/config-properties.adoc
@timefoldai/docs:dev:     source: /Users/jurriaanpersyn/Documents/GitHub/timefold-solver (branch: main <worktree> | start path: docs/src)
@timefoldai/docs:dev: [17:11:01.620] WARN (asciidoctor): skipping reference to missing attribute: property_prefix
@timefoldai/docs:dev:     file: /Users/jurriaanpersyn/Documents/GitHub/timefold-solver/docs/src/modules/ROOT/pages/integration/config-properties.adoc
@timefoldai/docs:dev:     source: /Users/jurriaanpersyn/Documents/GitHub/timefold-solver (branch: main <worktree> | start path: docs/src)
@timefoldai/docs:dev: [17:11:01.620] WARN (asciidoctor): skipping reference to missing attribute: solver_name_prefix
@timefoldai/docs:dev:     file: /Users/jurriaanpersyn/Documents/GitHub/timefold-solver/docs/src/modules/ROOT/pages/integration/config-properties.adoc
@timefoldai/docs:dev:     source: /Users/jurriaanpersyn/Documents/GitHub/timefold-solver (branch: main <worktree> | start path: docs/src)
@timefoldai/docs:dev: [17:11:01.620] WARN (asciidoctor): skipping reference to missing attribute: property_prefix
@timefoldai/docs:dev:     file: /Users/jurriaanpersyn/Documents/GitHub/timefold-solver/docs/src/modules/ROOT/pages/integration/config-properties.adoc
@timefoldai/docs:dev:     source: /Users/jurriaanpersyn/Documents/GitHub/timefold-solver (branch: main <worktree> | start path: docs/src)
@timefoldai/docs:dev: [17:11:01.620] WARN (asciidoctor): skipping reference to missing attribute: property_prefix
@timefoldai/docs:dev:     file: /Users/jurriaanpersyn/Documents/GitHub/timefold-solver/docs/src/modules/ROOT/pages/integration/config-properties.adoc
@timefoldai/docs:dev:     source: /Users/jurriaanpersyn/Documents/GitHub/timefold-solver (branch: main <worktree> | start path: docs/src)
@timefoldai/docs:dev: [17:11:01.621] WARN (asciidoctor): skipping reference to missing attribute: property_prefix
@timefoldai/docs:dev:     file: /Users/jurriaanpersyn/Documents/GitHub/timefold-solver/docs/src/modules/ROOT/pages/integration/config-properties.adoc
@timefoldai/docs:dev:     source: /Users/jurriaanpersyn/Documents/GitHub/timefold-solver (branch: main <worktree> | start path: docs/src)
@timefoldai/docs:dev: [17:11:02.091] WARN (asciidoctor): skipping reference to missing attribute: timefoldsolverversion
@timefoldai/docs:dev:     file: /Users/jurriaanpersyn/Documents/GitHub/timefold-solver/docs/src/modules/ROOT/pages/quickstart/hello-world/hello-world-quickstart.adoc
@timefoldai/docs:dev:     source: /Users/jurriaanpersyn/Documents/GitHub/timefold-solver (branch: main <worktree> | start path: docs/src)
@timefoldai/docs:dev: [17:11:02.091] WARN (asciidoctor): skipping reference to missing attribute: logbackversion
@timefoldai/docs:dev:     file: /Users/jurriaanpersyn/Documents/GitHub/timefold-solver/docs/src/modules/ROOT/pages/quickstart/hello-world/hello-world-quickstart.adoc
@timefoldai/docs:dev:     source: /Users/jurriaanpersyn/Documents/GitHub/timefold-solver (branch: main <worktree> | start path: docs/src)
@timefoldai/docs:dev: [17:11:02.208] WARN (asciidoctor): skipping reference to missing attribute: wiringannotationfq
@timefoldai/docs:dev:     file: /Users/jurriaanpersyn/Documents/GitHub/timefold-solver/docs/src/modules/ROOT/pages/quickstart/shared/constrainttests.adoc
@timefoldai/docs:dev:     source: /Users/jurriaanpersyn/Documents/GitHub/timefold-solver (branch: main <worktree> | start path: docs/src)
@timefoldai/docs:dev: [17:11:02.208] WARN (asciidoctor): skipping reference to missing attribute: testannotationfq
@timefoldai/docs:dev:     file: /Users/jurriaanpersyn/Documents/GitHub/timefold-solver/docs/src/modules/ROOT/pages/quickstart/shared/constrainttests.adoc
@timefoldai/docs:dev:     source: /Users/jurriaanpersyn/Documents/GitHub/timefold-solver (branch: main <worktree> | start path: docs/src)
@timefoldai/docs:dev: [17:11:02.208] WARN (asciidoctor): skipping reference to missing attribute: testannotation
@timefoldai/docs:dev:     file: /Users/jurriaanpersyn/Documents/GitHub/timefold-solver/docs/src/modules/ROOT/pages/quickstart/shared/constrainttests.adoc
@timefoldai/docs:dev:     source: /Users/jurriaanpersyn/Documents/GitHub/timefold-solver (branch: main <worktree> | start path: docs/src)
@timefoldai/docs:dev: [17:11:02.208] WARN (asciidoctor): skipping reference to missing attribute: wiringannotation
@timefoldai/docs:dev:     file: /Users/jurriaanpersyn/Documents/GitHub/timefold-solver/docs/src/modules/ROOT/pages/quickstart/shared/constrainttests.adoc
@timefoldai/docs:dev:     source: /Users/jurriaanpersyn/Documents/GitHub/timefold-solver (branch: main <worktree> | start path: docs/src)
@timefoldai/docs:dev: [17:11:02.209] WARN (asciidoctor): skipping reference to missing attribute: testannotationfq
@timefoldai/docs:dev:     file: /Users/jurriaanpersyn/Documents/GitHub/timefold-solver/docs/src/modules/ROOT/pages/quickstart/shared/constrainttests.adoc
@timefoldai/docs:dev:     source: /Users/jurriaanpersyn/Documents/GitHub/timefold-solver (branch: main <worktree> | start path: docs/src)
@timefoldai/docs:dev: [17:11:02.209] WARN (asciidoctor): skipping reference to missing attribute: wiringannotationfq
@timefoldai/docs:dev:     file: /Users/jurriaanpersyn/Documents/GitHub/timefold-solver/docs/src/modules/ROOT/pages/quickstart/shared/constrainttests.adoc
@timefoldai/docs:dev:     source: /Users/jurriaanpersyn/Documents/GitHub/timefold-solver (branch: main <worktree> | start path: docs/src)
@timefoldai/docs:dev: [17:11:02.209] WARN (asciidoctor): skipping reference to missing attribute: testannotation
@timefoldai/docs:dev:     file: /Users/jurriaanpersyn/Documents/GitHub/timefold-solver/docs/src/modules/ROOT/pages/quickstart/shared/constrainttests.adoc
@timefoldai/docs:dev:     source: /Users/jurriaanpersyn/Documents/GitHub/timefold-solver (branch: main <worktree> | start path: docs/src)
@timefoldai/docs:dev: [17:11:02.209] WARN (asciidoctor): skipping reference to missing attribute: wiringannotation
@timefoldai/docs:dev:     file: /Users/jurriaanpersyn/Documents/GitHub/timefold-solver/docs/src/modules/ROOT/pages/quickstart/shared/constrainttests.adoc
@timefoldai/docs:dev:     source: /Users/jurriaanpersyn/Documents/GitHub/timefold-solver (branch: main <worktree> | start path: docs/src)
@timefoldai/docs:dev: [17:11:02.210] WARN (asciidoctor): unterminated listing block
@timefoldai/docs:dev:     file: /Users/jurriaanpersyn/Documents/GitHub/timefold-solver/docs/src/modules/ROOT/pages/quickstart/shared/java-logback-config.adoc:4
@timefoldai/docs:dev:     source: /Users/jurriaanpersyn/Documents/GitHub/timefold-solver (branch: main <worktree> | start path: docs/src)
@timefoldai/docs:dev: [17:11:02.215] WARN (asciidoctor): skipping reference to missing attribute: quickstarts-clone-url
@timefoldai/docs:dev:     file: /Users/jurriaanpersyn/Documents/GitHub/timefold-solver/docs/src/modules/ROOT/pages/quickstart/shared/solutionsourcecode.adoc
@timefoldai/docs:dev:     source: /Users/jurriaanpersyn/Documents/GitHub/timefold-solver (branch: main <worktree> | start path: docs/src)
@timefoldai/docs:dev: [17:11:02.215] WARN (asciidoctor): skipping reference to missing attribute: quickstarts-archive-url
@timefoldai/docs:dev:     file: /Users/jurriaanpersyn/Documents/GitHub/timefold-solver/docs/src/modules/ROOT/pages/quickstart/shared/solutionsourcecode.adoc
@timefoldai/docs:dev:     source: /Users/jurriaanpersyn/Documents/GitHub/timefold-solver (branch: main <worktree> | start path: docs/src)
@timefoldai/docs:dev: [17:11:02.215] WARN (asciidoctor): skipping reference to missing attribute: framework-quickstart-url
@timefoldai/docs:dev:     file: /Users/jurriaanpersyn/Documents/GitHub/timefold-solver/docs/src/modules/ROOT/pages/quickstart/shared/solutionsourcecode.adoc
@timefoldai/docs:dev:     source: /Users/jurriaanpersyn/Documents/GitHub/timefold-solver (branch: main <worktree> | start path: docs/src)

After:

🪄

@oemebamo oemebamo had a problem deploying to documentation (preview) June 5, 2025 15:12 — with GitHub Actions Failure
@sonarqubecloud SonarQubeCloud
Copy link

sonarqubecloud bot commented Jun 5, 2025

Quality Gate Passed Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarQube Cloud

@oemebamo oemebamo had a problem deploying to documentation (preview) June 6, 2025 15:54 — with GitHub Actions Failure
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
1 participant
@oemebamo