Skip to content

v2.0.1

Choose a tag to compare

@github-actions github-actions released this 20 Nov 06:30
· 79 commits to main since this release
289bc20

Added

  • A documentation site at https://propertybag.ncode.io/, built from docs/site/ by the shared NCodeGroup/docs toolchain: a quick start, a guide for each task, the concepts behind keys and the default bag, and an API map of every public member, which the gate checks against both PublicAPI.Shipped.txt files. .github/workflows/docs.yml builds it on every pull request and publishes it from main (#37, ADR-1005, ADR-1008, ADR-1009).
  • Every C# sample on the site is a compiled test in tests/NCode.PropertyBag.Site.Tests that uses only the public API, and the gate checks every sample's marker and key (#37, ADR-1006).
  • The gate compiles every example in the XML documentation of src/ against both packages (build/Test-XmlDocExamples.ps1), so each example IntelliSense shows builds as written (#37).

Changed

  • Package validation compares each package with the published 2.0.0 package.
  • Each package's project website on nuget.org is the documentation site, https://propertybag.ncode.io/, instead of the repository (#37, ADR-1009).
  • The repository README and both package READMEs link to the documentation site (#37).
  • The XML documentation of IReadOnlyPropertyBag.Clone says that how values are copied is up to the implementation, and that the default implementation clones each ICloneable value, as the README and the documentation site say; it described every copy as shallow.
  • The README samples check is build/Assert-Markdown.ps1, which the gate tests offline first; it reads file names as git stores them and fails when git fails, where a failure read as "nothing changed" (#37).