QRun-IO/ci-policy: ci / fork-guard (pull_request) Skipped
QRun-IO/ci-policy: native / fork-deny (pull_request) Skipped
QRun-IO/ci-policy: native / dotnet-0 (pull_request) Skipped
QRun-IO/ci-policy: ci / Scoped workflow [workflow 539bec410f7926fec3ef7fabe51934a91e0248be] (pull_request) Successful in 10s
QRun-IO/ci-policy: ci / head-profile (pull_request) Skipped
QRun-IO/ci-policy: native / native-result (pull_request) Successful in 10s
QRun-IO/ci-policy: ci / repository-policy (pull_request) Skipped
QRun-IO/ci-policy: ci / application-template-0 (pull_request) Skipped
QRun-IO/ci-policy: ci / gradle-1 (pull_request) Skipped
QRun-IO/ci-policy: ci / java-core-2-head (pull_request) Skipped
QRun-IO/ci-policy: ci / java-docker-3 (pull_request) Skipped
QRun-IO/ci-policy: ci / java-docker-3-head (pull_request) Skipped
QRun-IO/ci-policy: ci / java-docker-4 (pull_request) Skipped
QRun-IO/ci-policy: ci / java-frontend-browser-5 (pull_request) Skipped
QRun-IO/ci-policy: ci / java-maven-6 (pull_request) Skipped
QRun-IO/ci-policy: ci / java-maven-6-head (pull_request) Skipped
QRun-IO/ci-policy: ci / java-maven-7 (pull_request) Skipped
QRun-IO/ci-policy: ci / java-maven-7-head (pull_request) Skipped
QRun-IO/ci-policy: ci / node-8 (pull_request) Skipped
QRun-IO/ci-policy: ci / node-9 (pull_request) Skipped
QRun-IO/ci-policy: ci / node-10 (pull_request) Skipped
QRun-IO/ci-policy: ci / node-playwright-11 (pull_request) Skipped
QRun-IO/ci-policy: ci / repository-policy-12 (pull_request) Skipped
QRun-IO/ci-policy: ci / source-config-13 (pull_request) Skipped
QRun-IO/ci-policy: ci / source-config-14 (pull_request) Skipped
QRun-IO/ci-policy: ci / android-0 (pull_request) Skipped
QRun-IO/ci-policy: ci / original-business (pull_request) Skipped
QRun-IO/ci-policy: ci / original-mcp (pull_request) Skipped
QRun-IO/ci-policy: ci / original-voyage (pull_request) Skipped
QRun-IO/ci-policy: ci / original-cli (pull_request) Skipped
QRun-IO/ci-policy: ci / not-enrolled (pull_request) Skipped
QRun-IO/ci-policy: ci / shared-pipeline (pull_request) Skipped
QRun-IO/ci-policy: ci / ci-result (pull_request) Successful in 9s
maven / build (push) Successful in 12m21s
build / maven (push) Successful in 12m21s
Pin QQQ Core 4.1.0-RC.22, Record Files 0.1.0-RC.1 and Scripting 1.0.0 in place of the SNAPSHOT placeholders, and replace the unreleased-checkpoint text. Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com>
24 lines
2.1 KiB
Markdown
24 lines
2.1 KiB
Markdown
# Document Generation — current status
|
|
|
|
**Version 1.0**, built and published by the shared `ci-workflows` Maven pipeline to the KOF22 Gitea Maven registry (`com.kingsrook.qbits`). `mvn deploy` runs every module's tests once. Depends on QQQ Core `4.1.0-RC.22`, Record Files `0.1.0-RC.1` and Scripting `1.0.0`.
|
|
|
|
## Purpose
|
|
|
|
User-defined document templates, sizes, PDF/ZPL generation, barcode rendering and integrations with scripting, retained files and printing.
|
|
|
|
## Repository layout
|
|
|
|
`foundation/` owns metadata, revisions, requests and audit contracts. `renderer/` contains rendering and vendored corresponding source. `bridges/` contains optional integrations. The root Maven reactor lists all modules.
|
|
|
|
## Building and installation
|
|
|
|
Use Java 21 and the included Maven wrapper. Component example: `./mvnw -pl foundation -am verify`. Database tests use their Testcontainers fixtures and require Docker. The full `./mvnw verify` currently has the blockers below; it is not an installation proof.
|
|
|
|
## Evidence retained
|
|
|
|
Foundation: 225 tests passed with zero failures/errors/skips, Checkstyle clean and coverage gate met. The definition-rename change (native `document_generation_{type,stock,template}_author_rename` actions, see [authoring](AUTHORING.md)) was first qualified by GG Forge as a local patch (37 rename-related tests on H2, MySQL and PostgreSQL 17) and then re-verified on this branch with `./mvnw -pl foundation -am verify`: 232 tests passed with zero failures/errors/skips, Checkstyle clean and coverage gate met, including the Docker MySQL 8.4 and PostgreSQL 17 suites. No schema change. Renderer bridge: 52 tests passed; remote transport: 19 passed. A clean consumer resolved the foundation/remote modules. The patched OpenHTML module passed 15 tests. These are component results, not a complete released-system acceptance.
|
|
|
|
## Source and release state
|
|
|
|
The starting source was extracted from Website-Backend commit b6fb23825a87412397dec703b9617148ae7eb601, then adapted for standalone packaging; existing licenses are preserved. See [known issues](KNOWN-ISSUES.md) and the README for the API and integration documentation.
|