Skip to content

CHDSharp v1.6.1

Choose a tag to compare

@github-actions github-actions released this 02 Nov 16:31
· 14 commits to main since this release
0570027

CHDSharp v1.6.1 - What's New

Released: 2026-11-02 - Full changelog - NuGet

CHDSharp v1.6.1 is a bug-fix release for the CLI's automatic bug reporting and a documentation
release for the API reference. Expected user mistakes no longer reach the Bug Report API, and the
full per-member API reference is now generated by DocFX and published with the docs site.


Download (CLI)

Platform Bundle
Windows x64 CHDSharp_win-x64_v1.6.1.zip
Windows ARM64 CHDSharp_win-arm64_v1.6.1.zip
Linux x64 CHDSharp_linux-x64_v1.6.1.zip
Linux ARM64 CHDSharp_linux-arm64_v1.6.1.zip
macOS Intel CHDSharp_osx-x64_v1.6.1.zip
macOS Apple Silicon CHDSharp_osx-arm64_v1.6.1.zip

Every bundle contains a framework-dependent single-file CHDSharp / CHDSharp.exe
build (the .NET runtime is not embedded) plus LICENSE.txt, README.md, README.txt
and this document. The .NET 10 runtime
is required.


Fixed: the bug-report API only receives real bugs

The Bug Report API had 383 CHDSharpCli reports and every one was a normal validation outcome, not
a defect: 382 Data size ... is not divisible by sector size 2048 and one
createdvd requires --input <file> --output <file>. Both paths already matched chdman
(chdman.cpp:2263, chdman.cpp:2088): same console text, same exit code 1, no partial output.
They were logged at Warning, and the sink forwards every Warning+ event.

  • The CLI now logs expected user/usage errors through logger.UserError(...), which keeps them at
    warning level in the console and in the rolling file log but tags them so BugReportSink does
    not post them.
  • 216 call sites were reclassified: unknown options, invalid numeric arguments, missing paths,
    sector-misaligned input, an existing output file without --force, overridden format options,
    unsupported option combinations, and similar usage diagnostics.
  • Genuine runtime failures stay on logger.Warning(...) and are still reported: Open failed,
    * failed: {Message}, verification failures, TOC and track extraction failures, and
    access-denied errors.
  • Console text and exit codes are unchanged, so chdman parity is untouched (quick battle harness:
    905/905 checks).

New: generated API reference on the documentation site

The public surface is now documented per member at
purelogiccode.github.io/CHDSharp/api/, generated by
DocFX from the XML documentation of CHDSharpLib.

  • DocFX is pinned in .config/dotnet-tools.json and driven by scripts/build-api-docs.ps1, so the
    same command produces the same output locally and in CI.
  • A new Pages workflow builds the Jekyll guides and the DocFX reference into one artifact and
    deploys it (Pages now uses build_type: workflow); the wiki sync no longer requests a legacy
    Pages rebuild.
  • The reference uses the same GitHub-dark palette as the rest of the site.
  • 14 duplicate <param> XML-documentation blocks in CHD.cs were removed, so DocFX metadata now
    generates with 0 warnings.

Verification

  • dotnet build -c Release: 0 warnings, 0 errors; jb inspectcode --severity=WARNING: 0 findings.
  • Quick chdman parity battle: 905/905 checks passed.
  • CI gate: three-OS build/test across net8.0/net9.0/net10.0, InspectCode, NuGet packaging,
    merged coverage, Jekyll + DocFX docs build, and the chdman parity smoke.
  • No public API changes - behavior, diagnostics and documentation only.