Table of Contents

Jiro.Libs v3.0.0 "Shinpo"

Release Date: 2025/07/12
Release Type: Major Release
Branch: main
Code Name: Shinpo (進歩) - "Progress & Advancement"

🎉 Overview

This is a major release of Jiro.Libs that significantly improves the developer experience with enhanced tooling, comprehensive documentation, improved code quality, and modernized dependencies. This release establishes professional development standards and introduces robust CI/CD automation.

✨ Features Added

Development Infrastructure

  • EditorConfig: Comprehensive code formatting rules for consistent development across all file types
  • GitAttributes: Proper line ending and file type handling for cross-platform development
  • GitHub Actions Suite: Complete CI/CD pipeline with specialized workflows
    • Core .NET CI (jiro-kernel-ci.yml)
    • Release management (create-release.yml)
    • Security scanning (jiro-kernel-security.yml)
    • Docker containerization (docker-build.yml)
    • Documentation deployment (deploy-docs.yml)
    • Markdown linting (markdown-lint.yml)
    • Performance testing (jiro-kernel-performance.yml)

Code Quality & Documentation

  • XML Documentation: Comprehensive API documentation for all public interfaces
  • Enhanced Type Safety: Improved parameter parsing with better error handling
  • Quote-Aware Tokenization: Advanced command parsing supporting quoted arguments
  • Improved Exception Handling: Better error messages and type conversion failures

Framework Enhancements

  • JsonResult: New result type for JSON command outputs
  • Enhanced Parsing: Robust type parsing with culture-aware conversion
  • Package Metadata: Added README.md to NuGet package for better discoverability

🔄 Changes

Dependencies Update

  • Microsoft.Extensions.Configuration: Added v9.0.0 for enhanced configuration support
  • Microsoft.Extensions.DependencyInjection: Updated to v9.0.0
  • Microsoft.Extensions.Logging: Updated to v9.0.0
  • Removed Legacy Dependencies: Cleaned up outdated ASP.NET Core references
  • Framework Reference: Switched to proper Microsoft.AspNetCore.App framework reference

Code Structure

  • Consistent Formatting: Applied EditorConfig rules across all source files
  • Documentation Standards: Added comprehensive XML documentation to all models and results
  • Namespace Organization: Improved code organization and consistency

CI/CD Pipeline

  • Workflow Separation: Individual workflows for specific concerns (build, security, docs)
  • Automated Testing: Enhanced testing pipeline with coverage reporting
  • Security Integration: Weekly security scans and vulnerability checks
  • Multi-platform Support: Build and test across Linux, Windows, and macOS

🛠️ Technical Details

Enhanced Command Processing

  • Quote-Aware Parsing: Commands now properly handle quoted arguments with spaces
  • Improved Type Conversion: Better error handling for parameter parsing failures
  • Culture-Aware Parsing: Consistent parsing behavior across different locales

Documentation Infrastructure

  • DocFX Integration: Automated API documentation generation
  • GitHub Pages: Automatic documentation deployment
  • Markdown Standards: Enforced markdown linting for consistent documentation

Security & Quality

  • CodeQL Analysis: Automated security vulnerability scanning
  • Dependency Scanning: Regular security audits for third-party packages
  • Container Security: Trivy scanning for Docker images

📦 Components

Libraries

  • Jiro.Commands (v3.0.0): Enhanced command and plugin framework with improved documentation

Development Tools

  • GitHub Actions: 8 specialized workflows for different aspects of CI/CD
  • EditorConfig: Comprehensive formatting rules for 15+ file types
  • Scripts: Enhanced build and documentation generation scripts

Examples

  • ExampleApp: Updated with latest dependencies and improved structure
  • ExamplePlugin: Reference implementation with best practices

🔧 Installation

NuGet Package

dotnet add package Jiro.Commands --version 3.0.0

Package Features

  • Includes README.md for better package documentation
  • Comprehensive XML documentation for IntelliSense support
  • Modern .NET 9.0 framework targeting

📊 Release Metrics

  • XML Documentation Coverage: 100% of public APIs documented
  • CI/CD Workflows: 8 specialized GitHub Actions workflows
  • Code Quality Rules: 200+ EditorConfig formatting rules
  • Dependencies: Modernized to .NET 9.0 ecosystem
  • File Types Supported: 15+ file types with consistent formatting
  • Security Scans: Weekly automated vulnerability assessments

🚀 Migration Guide

From v2.0.0 to v3.0.0

Dependency Updates

  1. Update to .NET 9.0 if not already done
  2. Remove any manual ASP.NET Core package references (now uses framework reference)
  3. Update project files to use new dependency versions

Code Changes

  • No Breaking Changes: All existing APIs remain compatible
  • Enhanced Documentation: IntelliSense now shows comprehensive documentation
  • Improved Error Messages: Type parsing errors now include more context

Development Environment

  1. Apply EditorConfig settings for consistent formatting
  2. Configure Git attributes for proper line endings
  3. Review GitHub Actions workflows if using this repository

🔮 What's Next

Upcoming Features (v3.1.0)

  • Performance optimizations based on benchmark results
  • Additional result types for specialized outputs
  • Enhanced plugin hot-reloading capabilities
  • Advanced command composition features

Long-term Roadmap

  • Visual Studio Code extension for plugin development
  • Advanced debugging tools for command execution
  • Plugin marketplace integration
  • Real-time command collaboration features

📝 Breaking Changes

None - This release maintains full backward compatibility with v2.0.0 while adding significant new functionality and improvements.

🔒 Security Enhancements

  • Automated Security Scanning: Weekly CodeQL analysis and dependency audits
  • Container Security: Trivy scanning for Docker images
  • Dependency Management: Automated vulnerability detection and reporting
  • Secure Development: EditorConfig and GitAttributes for consistent, secure coding practices

🙏 Acknowledgments

This release represents a major step forward in establishing Jiro.Libs as a professional, enterprise-ready framework with comprehensive tooling, documentation, and quality assurance processes.

Full Changelog: v2.0.0...v3.0.0
Documentation: huebyte.github.io/Jiro.Libs
Issues: GitHub Issues
Security Advisories: Security Advisories

Edit this page