Repository Public
1<!--2ORIX Docs3File: docs/release/checklist.md4Description: Release quality gates for version 1.0.0, each with its status and the file that proves it.5Author: Simon-Pierre Boucher6Contact: contact@spboucher.ai7-->8# Release checklist — version 1.0.0 (build 2)910State on 2026-11-21. A gate is marked **✓** only when a file proves it; **partial** when the evidence covers part of the claim, with the missing part named; **✗** when it is not done.1112Evidence files quoted throughout:1314* [`test-results.json`](../reports/test-results.json) — engine tests: 582 tests, 85 suites, 10 targets, `passed`, 0 issues; interaction self-test: 19 scenarios, 19 passed, 0 failed; recovery: `PASS: autosaved text survived SIGKILL`.15* [`selftest-release.json`](../reports/selftest-release.json) — the 19 interaction scenarios recorded for the Release build: 19 passed, 0 failed. The file lists each scenario by name.16* [`coverage.json`](../reports/coverage.json) — engine line coverage 92.9 %.17* `dist/release.json` — not committed; its content is reproduced in [distribution.md](distribution.md), [signing.md](signing.md) and [notarization.md](notarization.md).1819The test report records totals, not the outcome of each test by name. Where a gate cites a named test, the proof is that the test exists in the sources and that the run as a whole passed with 0 issues.2021## Product gates2223| # | Gate | Status | Evidence | Notes |24|---|---|:---:|---|---|25| 1 | Application builds | ✓ | `dist/release.json` (version 1.0.0, build 2, architectures x86_64 and arm64); [`Scripts/release.sh`](../../Scripts/release.sh); the self-test ran inside the built application ([`test-results.json`](../reports/test-results.json)) | The Intel slice is built, never run. |26| 2 | Rich text editing works | ✓ | [`selftest-release.json`](../reports/selftest-release.json) scenarios "typing, Return and Backspace", "Unicode typing deletes whole characters", "arrow keys, word and line movement", "undo, redo and select all", "bold shortcut applies to typed text", "copy, cut and paste through the pasteboard", "lists: …"; `DocModelTests` in [`test-results.json`](../reports/test-results.json) | Events are synthesised in-process; the XCUITest suite was not run ([testing.md](../development/testing.md#xcuitest-suite)). |27| 3 | Pagination validated | partial | `Tests/DocLayoutTests/PaginationTests.swift`; rule-by-rule table in [pagination.md](../architecture/pagination.md#summary); scenario "page breaks create pages; many pages scroll with the caret" | Rules without a test: space before and after, the footnote reserve, float registration and carried exclusions, lists of figures and tables. Layout is not compared with any other application. |28| 4 | Styles | ✓ | `DocModelTests` (character and paragraph formatting, style inheritance); DOCX feature check "styles": 19 documents, 699 instances, 19 pass, 0 fail ([docx-compatibility.md](../reports/docx-compatibility.md#per-feature)); `DocTemplatesTests` | The Styles inspector itself is covered by no automated interaction; it appears in [`20-styles.png`](../screenshots/20-styles.png). |29| 5 | Tables | ✓ | Scenario "table: insert, type, Tab between cells, new row at the end"; `DocModelTests` (table editing, sorting, formulas); `tablesSplitByRowsAndRepeatTheirHeader`, `mergedCellsCoverTheirGrid` ([pagination.md](../architecture/pagination.md#tables)) | Rows do not split across pages; no nested tables ([limitations.md](../compatibility/limitations.md#tables)). |30| 6 | Images and figures | partial | `imagesKeepTheirResolution` ([pdf.md](../architecture/pdf.md#what-is-written)); DOCX feature checks "images" and "image assets" 3 / 3 documents pass; `floatingObjectsNarrowTheLinesBesideThem` | No interaction scenario inserts or resizes an image; float placement across pages has no pagination test ([pagination.md](../architecture/pagination.md#floats)). |31| 7 | Equations | ✓ | `Tests/DocLayoutTests/MathRobustnessTests.swift` (hostile and random LaTeX, valid equations typeset); `MathConverterTests`; DOCX feature check "equations" 3 / 3; DocMath coverage 100.0 % ([`coverage.json`](../reports/coverage.json)) | A subset of LaTeX math ([limitations.md](../compatibility/limitations.md#mathematics)). |32| 8 | Document saving reliable | ✓ | `Tests/DocFormatsTests/NativeContainerTests.swift` (lossless round trip, corruption detected, recovery) — see [formats.md](../compatibility/formats.md#native-orixdoc); scenario "save, reopen and autosave through NSDocument" | Files larger than a few megabytes were not verified. |33| 9 | Autosave validated | ✓ | `"recovery": "PASS: autosaved text survived SIGKILL"` in [`test-results.json`](../reports/test-results.json); [`Scripts/recovery-test.sh`](../../Scripts/recovery-test.sh) | Scope: a saved document. Untitled documents, a kill during a write and power loss are not covered ([persistence.md](../architecture/persistence.md#recovery-after-a-kill)). |34| 10 | DOCX import/export tested | ✓ | [docx-compatibility.md](../reports/docx-compatibility.md): 19 / 19 imported, model equal after both cycles 19 / 19, text integrity 100.00 %, 172 / 0 feature checks; pandoc, `textutil` and LibreOffice read the exports 19 / 19 | **Microsoft Word was not used.** Small, mostly synthetic corpus; layout not measured. |35| 11 | Unsupported DOCX features disclosed | ✓ | [compatibility/docx.md](../compatibility/docx.md) (feature tables with "Approximated" and "Not supported"); import warnings by document in [docx-compatibility.md](../reports/docx-compatibility.md#import-warnings-by-document); [limitations.md](../compatibility/limitations.md#docx) | Warnings are also shown in the app on open and before export ([`18-export-sheet.png`](../screenshots/18-export-sheet.png)). |36| 12 | PDF output validated | partial | `Tests/DocLayoutTests/PDFTests.swift` (pages, text extraction with PDFKit, links, outline, crop marks, page range; Poppler checks for embedded fonts and image resolution) — [pdf.md](../architecture/pdf.md#what-is-written) | No PDF/A or PDF/UA validator was run and no conformance is claimed. The report does not record whether the Poppler checks ran or were skipped. Tag structure is partial. |37| 13 | Comments and revisions | ✓ | Scenarios "track changes: insert, delete, accept and reject" and "comment anchored on the selection"; `TrackChangesTests`; DOCX feature checks for comments, replies and tracked insertions, deletions, format changes and paragraph marks, all pass | What is not tracked is listed in [text-engine.md](../architecture/text-engine.md#5-editing-operations). |38| 14 | Long-document performance measured | ✓ | [`benchmarks.json`](../reports/benchmarks.json) (487 pages, 177162 words) and [`benchmarks-100-pages.json`](../reports/benchmarks-100-pages.json) (98 pages); meanings in [performance.md](../development/performance.md) | Single runs, synthetic document, one machine; drawing and end-to-end typing latency are not measured. |39| 15 | No known release-blocking crashes | ✓ | [`test-results.json`](../reports/test-results.json): 0 issues, 19 / 19; [`selftest-release.json`](../reports/selftest-release.json): 0 failed; hostile-input tests listed in [security.md](../security.md#hostile-input-tests) | "Known" means recorded in this repository: none is. The application has no crash reporting, and it was run on one Mac. |40| 16 | Privacy declarations accurate | ✓ | `OnDeviceOnlyTests` in `Tests/DocAutomationTests/IntelligenceTests.swift`; empty [`ORIXDocs.entitlements`](../../App/Resources/ORIXDocs.entitlements); [security.md](../security.md#no-network-code) | The no-network test scans five source folders; for the rest of the sources the statement rests on a search made on 2026-11-21, not on a test. |41| 17 | Accessibility reviewed | partial | [accessibility.md](../reports/accessibility.md) | Review by code inspection only. No VoiceOver session with a listener; Reduce Motion and Increase Contrast not handled. |42| 18 | Icon assets valid | ✓ | `App/Resources/Assets.xcassets/AppIcon.appiconset` (seven PNG files, 16 to 1024 px, ten slots in `Contents.json`, each with a file); [icon-design.md](../design/icon-design.md); `AppIcon.icns` present in the built bundle | Pixel sizes were checked with `sips` on 2026-11-21. |43| 19 | README complete | ✓ | [`README.md`](../../README.md): 38 sections, 22 screenshots, 10 diagrams; relative links and image paths checked on disk | Its rendering on the SPB Git website is not verified (gate 26). |4445## Release gates4647| # | Gate | Status | Evidence | Notes |48|---|---|:---:|---|---|49| 20 | SPB Git repository verified | ✓ | Public repository https://git.spboucher.ai/orix-docs (published 2026-11-21); `git ls-remote` matches the local `main`; private copy on `gitsrv:srv/git-private/orix-docs.git` |50| 21 | Developer ID signature valid | ✓ | `dist/release.json` field `signing`: "Developer ID Application: Simon-Pierre Boucher (3YM54G49SN)"; [signing.md](signing.md#observed-on-version-100-build-1) | Hardened runtime, empty entitlements, no `get-task-allow`. |51| 22 | Notarization accepted | ✓ | `dist/release.json`: application `5cbffb9c-d031-4702-81c6-ecb0d1068eca` Accepted; disk image `794c8ee7-f0ef-491f-b7cc-7ab911771eca` Accepted; [notarization.md](notarization.md) | Both stapled. |52| 23 | Gatekeeper validation passes | ✓ | `dist/release.json` field `gatekeeper`: "accepted, source=Notarized Developer ID" for the application and the disk image | Assessed on the build machine. |53| 24 | Distribution artifacts verified | partial | [distribution.md](distribution.md): sizes, checksums, bundle content, stapling | Verified on the build machine only. No clean second Mac; the Intel slice never run; macOS 15 to 26 not tested. |54| 25 | Release checksums match | ✓ | `dist/SHA256SUMS.txt` equals the `sha256` fields of `dist/release.json`; `shasum -a 256 -c SHA256SUMS.txt` answered OK for both files on 2026-11-21 | Values in [distribution.md](distribution.md#artifacts-of-version-100-build-1). |55| 26 | SPB Git release verified | ✓ | Release `v1.0.0` at https://git.spboucher.ai/orix-docs/releases; assets downloaded back: checksums match, DMG stapled, Gatekeeper accepts (see RELEASE-REPORT.md §9) |5657## Not done, in one place5859| Item | Where it is described |60|---|---|61| XCUITest suite not run (Automation Mode needs the owner's authentication) | [testing.md](../development/testing.md#xcuitest-suite) |62| Microsoft Word never used to validate DOCX | [compatibility/docx.md](../compatibility/docx.md#how-this-was-validated--and-how-it-was-not) |63| No PDF/A or PDF/UA validation | [pdf.md](../architecture/pdf.md#what-is-not-claimed) |64| Shortcuts actions never run from Shortcuts | [automation.md](../development/automation.md#shortcuts-actions) |65| AppleScript deferred | [automation.md](../development/automation.md#applescript-deferred) |66| Automatic updates not implemented | [distribution.md](distribution.md#what-is-in-the-application-bundle) |67| VoiceOver not tested with a listener; Reduce Motion and Increase Contrast not handled | [accessibility.md](../reports/accessibility.md#gaps) |68| Grammar checking and autocorrection not implemented | [text-engine.md](../architecture/text-engine.md#13-spelling) |69| Clean second Mac and Intel hardware not used | [distribution.md](distribution.md#what-was-not-verified) |70| Publication on SPB Git and the `v1.0.0` release | [distribution.md](distribution.md#where-it-is-published) |7172## To do when publication is authorised73741. Push the repository to SPB Git and create the release `v1.0.0` with `ORIX-Docs-1.0.0.dmg`, `ORIX-Docs-1.0.0.zip` and `SHA256SUMS.txt`.752. Download each asset from the release page and compare its SHA-256 with [distribution.md](distribution.md#artifacts-of-version-100-build-1).763. Open the README on the forge: check the badges, the ten Mermaid diagrams, the 22 screenshots and the HTML tables.774. Update gates 20 and 26 and the Release Status table of the README.78