Skip to content

Source location in output for local builds - #571

Merged
ToddCooper merged 4 commits into
masterfrom
2026-08-PJM-ImproveDiagnostics
Aug 7, 2026
Merged

Source location in output for local builds#571
ToddCooper merged 4 commits into
masterfrom
2026-08-PJM-ImproveDiagnostics

Conversation

@PaulMartinsen

@PaulMartinsen PaulMartinsen commented Aug 6, 2026

Copy link
Copy Markdown
Collaborator

📑 Description

This PR adds an extra batch file (.ci\asciidoc-converter\build_standard_debug.bat) for debugging document build locally with trace that includes reasonably accurate source locations. For example, should one forget the required transaction-id when registering a transaction such as:

// This an example of an error. Here the required `transaction-id` is missing
[role=transaction]
=== Retrieve BICEPS Content [{var_transaction_id}]

The build trace will report the error with the filename and approximate line number (actually the error is on line 9, not 16):

   ⁝
2026-08-06 21:02:14 INFO  - Processing actors for transaction DEV-29.
2026-08-06 21:02:14 ERROR - volume2/dev-30/tf2-dev-30.adoc: line 16 -> Missing transaction-id on section with role of transaction
2026-08-06 21:02:14 ERROR - asciidoctor: FAILED: D:/Projects/BLS/SDPi/DEV.SDPi/asciidoc/sdpi-standard.adoc: Failed to load AsciiDoc document

This may aid in tracking down the offending issue. The document and artefacts will be generated in sdpi-documents/sdpi-standard-debug/, though it may not be particularly useful because…

The downside is that some of the document processing does not occur in debug mode, viz:

  • IssuesSectionPreprocessor: which populates the document with github issues (though this generally doesn't happen locally anway),
  • DisableSectNumsProcessor: which removes any occurrences of :sectnums: from the document to prevent the AscidoctorJ parser from rendering additional section numbers.
  • ReferenceSanitizerPreprocessor, ReferenceSanitizerPostprocessor: which re-writes links to conform to IHE guidelines.

Note

During normal builds, source information is incomprehensible by mortals. The example error above, for example. reports
an error in sdpi-standard.adoc: line -13633.

☑ Mandatory Tasks

The following aspects have been respected by the pull request assignee and at least one reviewer:

  • Changelog update… though not sure if it is appropriate since this one is about tooling?
  • Pull Request Assignee
  • Reviewer

…ly accurate in "debug" mode, with the pre- and post-processor extension hooks disabled. Source location is lost when these hooks run in normal builds.
@ToddCooper

Copy link
Copy Markdown
Contributor

@PaulMartinsen -- So is this PR ready for review & merge as part of our next SDPi Friday call on 7 August 2026?

@PaulMartinsen

Copy link
Copy Markdown
Collaborator Author

yep. Review, merge and be merry. Hopefully. I'll plan to address any review issues over the weekend.

@ToddCooper ToddCooper left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

All changes reviewed and approved

@ToddCooper
ToddCooper merged commit ed06ae9 into master Aug 7, 2026
2 checks passed
@github-project-automation github-project-automation Bot moved this from In Progress to Done in Gemini SDPi Releases Aug 7, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

Status: Done

Development

Successfully merging this pull request may close these issues.

2 participants