obsidian-plugin/anthonyfitzpatrick_manuscript-compiler
1
0
Fork 0
mirror of https://github.com/anthonyfitzpatrick/manuscript-compiler.git synced 2026-07-22 08:31:19 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions
anthonyfitzpatrick_manuscri.../RELEASE_READINESS.md
Anthony Fitzpatrick 71a14bffff Harden Obsidian plugin quality and release checks
2026-07-16 22:47:44 +02:00

4.3 KiB
Raw Blame History

0.9.3 Release Readiness

Current status

Version 0.9.3 remains a prerelease candidate. Automated gates cover the shared prepared Book, six native generators, format validators, browser-download cleanup, privacy, migration, and release allowlist. Live interoperability and platform download testing remain release blockers; this document does not claim they were performed.

Maintainer and author documentation is provided in ARCHITECTURE.md, DEVELOPER_GUIDE.md, USER_GUIDE.md, SECURITY.md, and CONTRIBUTING.md. Screenshot placeholders in the user guide remain publication work and are not claims of completed manual testing.

Supported workflow

  • Select the exact book root through File Explorer, command palette, or settings.
  • Review the compact outline and use Correct structure only when needed.
  • Choose DOCX, ODT, EPUB, HTML, Markdown, or XML.
  • Use only the formatting controls meaningful for that format.
  • For DOCX, ODT, EPUB, or HTML, choose whether later body paragraphs use the configured first-line indent; first paragraphs after headings and scene breaks remain unindented. Markdown exposes a portability note instead, and XML delegates presentation to its consumer.
  • Generate and validate bytes in memory, then start the host browser download/share flow.

No completed export is written into the Obsidian vault. There is no vault fallback, Electron path, external executable, background network request, telemetry, or dependency on another community plugin. User-selected support links may open an external website. The host controls the final destination and the plugin cannot verify that external filesystem copy after download dispatch.

Automated gates

Run and record current output before publishing:

  • npm run typecheck
  • npm run lint
  • npm test
  • npm run test:docx
  • npm run test:odt
  • npm run test:epub
  • npm run test:html
  • npm run test:markdown
  • npm run test:xml
  • npm run test:exports
  • npm run benchmark:large
  • npm run build
  • npm run package
  • npm run package:validate
  • npm audit
  • git diff --check

The release archive must be release/manuscript-compiler-0.9.3.zip and contain exactly main.js, manifest.json, and styles.css.

Attach those three files individually to the GitHub release. The release tag must be exactly 0.9.3, without a v prefix; the ZIP is optional and is not an installation dependency.

Runtime dependencies

Obsidian supplies the host API. fflate is the sole bundled runtime package and is used for DOCX, ODT, and EPUB ZIP generation plus structural inspection. HTML, Markdown, XML, filename handling, and download delivery add no runtime package.

Known limitations

  • Browser/host save prompts differ across Windows, macOS, Linux, and mobile.
  • Download dispatch is observable; final external persistence is not.
  • EPUB structural tests do not replace EPUBCheck and reader interoperability.
  • Word, LibreOffice, Vellum, EPUB readers, text editors, browsers, and XML tools may expose application-specific behaviour not visible to byte-level tests.
  • Complex Markdown layout and embedded media remain outside the fiction-manuscript model.
  • Raw Markdown source displays heading markers, not rendered bold text; verify heading appearance in a Markdown rendering view.
  • Markdown has no portable first-line indentation setting, and XML intentionally contains no presentation preference; their Create file notes make these limits explicit.

Manual blockers before 1.0

  • Complete all applicable items in MANUAL_TESTING.md.
  • Test download delivery on Windows, macOS, Linux, and mobile.
  • Inspect DOCX in Word/LibreOffice and import it into Vellum.
  • Inspect ODT in LibreOffice.
  • Inspect DOCX, ODT, EPUB, and HTML with Indent first line of paragraphs enabled and disabled, including first paragraphs after Chapter headings and scene breaks plus a copyright/front-matter page with indentation disabled.
  • Inspect bold structural headings and normal-weight prose in ODT and in at least two independent EPUB applications.
  • Inspect bold structural headings and normal-weight prose in standalone HTML offline in multiple browsers, rendered Markdown in a Markdown viewer, and presentation-neutral XML in XML-aware tools.
  • Test a large real-world Unicode manuscript and confirm no vault output or Blob URL leak.
  • Resolve discovered defects and repeat every automated gate.