Skip to content

v0.8.0

Choose a tag to compare

@github-actions github-actions released this 26 Sep 03:19
· 88 commits to main since this release

FsLiveDocs 0.8.0

Fixed

  • Transcripts, run blocks, and snapshot examples execute in a separate worker process, FsLiveDocs.TranscriptHost, instead of inside livedocs. FsLiveDocs itself uses Axial, and in one process its copy was bound in place of the documented project's, so an example calling an API newer than FsLiveDocs' copy failed with MissingMethodException or TypeLoadException even though it compiled. The worker references only FSharp.Core and FSharp.Compiler.Service, so the documented project's own dependency versions are loaded. This applies to Axial and to any other library FsLiveDocs shares with a documented project.

Changed

  • Each executed example set starts a worker process. The worker is stopped, with any processes it started, after 10 minutes; set FSLIVEDOCS_TRANSCRIPT_TIMEOUT_SECONDS to change the limit.
  • Output an example writes with printfn or eprintfn is still not part of the compared transcript. It now goes to the worker's stderr, which FsLiveDocs shows only when execution fails, instead of the livedocs console.
  • Generated snapshot-test projects copy the worker beside FsLiveDocs.Runner. Regenerate them with livedocs generate-tests.