Skip to content

Release v1.0.0

Choose a tag to compare

@github-actions github-actions released this 14 Aug 00:24

Synopsis turns the executable examples in a repository into readable living behavior documentation.

Included

  • Discover Cratis.Specifications, xUnit, and NUnit BDD-style C# specifications.
  • Discover Vitest/Mocha-style TypeScript and React specifications.
  • Discover Given/When/Then specifications in Screenplay .play files.
  • Generate a self-contained, searchable, printable HTML document.
  • Generate the versioned JSON behavior model for integrations.
  • Use the reusable Cratis.Synopsis library or the synopsis .NET tool.

Install

The release tool package is attached below and has been verified from a clean download:

mkdir -p .synopsis-packages
curl -fsSL -o .synopsis-packages/Cratis.Synopsis.Tool.1.0.0.nupkg \
  https://github.com/Cratis/Synopsis/releases/download/v1.0.0/Cratis.Synopsis.Tool.1.0.0.nupkg
dotnet tool install --global --add-source "$PWD/.synopsis-packages" \
  --version 1.0.0 Cratis.Synopsis.Tool
synopsis --version

The ordinary NuGet command will work as soon as the new repository's NuGet trusted-publishing policy is activated:

dotnet tool install --global Cratis.Synopsis.Tool