Dovetail.Report 1.2.0

📝 Dovetail.Report Tool

Dovetail.Report is a dotnet tool that generates a static, offline-capable HTML report of the DAGs of the pipelines generated by Dovetail. It's useful for helping to understand exactly how Dovetail is wiring the pipelines together.

dotnet tool install --global Dovetail.Report

For CI usage (see below), install it to a local tool manifest instead, so the pinned version is explicit and reproducible rather than always floating to latest:

dotnet new tool-manifest # if your repo doesn't already have one
dotnet tool install Dovetail.Report

🏃 Running

dovetail-report --project path/to/MyApp.csproj

Or --solution path/to/MyApp.sln to report on every project in a solution at once. Omit both to auto-discover in the current directory.

Reports write to ./dovetail-report by default; pass --output <path> to choose another location. Each run replaces that directory's previous contents entirely, so no stale pages are left behind from a since-renamed or since-removed pipeline.

dovetail-report --project Dovetail.Example/Dovetail.Example.csproj --output ./report

📂 Output

The output directory is fully self-contained: index.html, one {FullyQualifiedPipelineName}.html page per discovered pipeline, and a vendor/ folder holding the pinned Mermaid.js build and stylesheet the pages need. Open index.html directly from disk. Nothing on the page reaches out to the network.

Projects with no pipelines will produce an empty report. Projects that don't compile will fail the report generator.

⚒️ Using in CI

As long as you have Dovetail.Report in your repo's tool manifest, dotnet tool restore will pull the tool in, and dovetail-report can be used as a step in your CI build. Here's a GitHub Actions example:

- name: Generate Dovetail report
  run: |
    dotnet tool restore
    dotnet tool run dovetail-report --project MyApp/MyApp.csproj --output dovetail-report

- name: Upload Dovetail report
  uses: actions/upload-artifact@v4
  with:
    name: dovetail-report
    path: dovetail-report