Skip to content

Releases: Gijsreyn/bicep-local-docgen

v1.0.1

17 Sep 01:37

Choose a tag to compare

Fixed

  • Fixed images and link

v1.0.0

17 Sep 01:30

Choose a tag to compare

Added

  • Initial release of Bicep.LocalDeploy.DocGenerator CLI tool
  • Initial release of Bicep.LocalDeploy library for model annotations
  • Documentation generation from C# Bicep models with attributes
  • Support for .biceplocalgenignore files to exclude files from processing
  • Two main CLI commands:
    • generate: Generate Markdown documentation from Bicep models
    • check: Validate that models have required documentation attributes
  • Comprehensive attribute system for customizing documentation:
    • BicepDocCustomAttribute: Add custom documentation content
    • BicepDocExampleAttribute: Provide usage examples
    • BicepDocHeadingAttribute: Control heading structure
    • BicepFrontMatterAttribute: Add front matter to generated files
  • Support for multiple target frameworks (.NET 9.0 and .NET 10.0)
  • Configurable output directory and file patterns
  • Verbose logging support
  • Force overwrite option for existing files

Features

  • Ignore file Support: Full support for .biceplocalgenignore files with glob patterns
    • Single filename patterns (e.g., Widget.cs)
    • Directory patterns (e.g., Models/**)
    • Wildcard patterns (e.g., Generated/*.cs)
    • Relative path patterns (e.g., Models/Widget.cs)
    • Comments support (lines starting with #)
  • Cross-Platform: Works on Windows, macOS, and Linux