Update PSBuild module to version 1.1.0 with enhancements including improved object model using PSCustomObjects, better git status detection, and comprehensive help comments. Added new utility functions and updated documentation to reflect changes.

Author: Github Actions

scripts/PSBuild.psd1

@@ -1,7 +1,7 @@
 @{
     # Module information
     RootModule = 'PSBuild.psm1'
-    ModuleVersion = '1.0.0'
+    ModuleVersion = '1.1.0'
     GUID = '15dd2bfc-0f11-4c8a-b98a-f2529558f423'
     Author = 'ktsu.dev'
     CompanyName = 'ktsu.dev'
@@ -49,6 +49,8 @@
         'Test-AnyFiles',
         'Get-GitLineEnding',
         'Set-GitIdentity',
+        'Write-InformationStream',
+        'Invoke-ExpressionWithLogging',
 
         # High-level workflow functions
         'Invoke-BuildWorkflow',
@@ -79,7 +81,15 @@
             LicenseUri = 'https://github.com/ktsu-dev/PSBuild/blob/main/LICENSE.md'
             ProjectUri = 'https://github.com/ktsu-dev/PSBuild'
             ReleaseNotes = @'
-Initial release of PSBuild module featuring:
+v1.1.0:
+- Improved object model using PSCustomObjects instead of hashtables
+- Enhanced git status detection and commit handling
+- Fixed logging and variable capture issues
+- Added comprehensive help comments to all functions
+- Added utility functions to the exported functions list
+
+v1.0.0:
+- Initial release of PSBuild module featuring:
 - Semantic versioning based on git history
 - Automatic version calculation from commit analysis
 - Metadata file generation and management

scripts/README.md

@@ -11,7 +11,6 @@ A comprehensive PowerShell module for automating the build, test, package, and r
 - NuGet package creation and publishing
 - GitHub release creation with assets
 - Proper line ending handling based on git config
-- Robust version string handling with automatic whitespace trimming
 
 ## Installation
 
@@ -50,6 +49,21 @@ if ($result.Success) {
 }
 ```
 
+## Object Model
+
+The module consistently uses PSCustomObjects for return values and data storage, providing several benefits:
+
+- Easy property access with dot notation
+- Better IntelliSense support in modern editors
+- Consistent patterns throughout the codebase
+- More efficient memory usage
+- Clearer code structure
+
+Each function returns a standardized object with at least:
+- `Success`: Boolean indicating operation success
+- `Error`: Error message if operation failed
+- `Data`: Object containing function-specific results
+
 ## Managed Files
 
 The module manages several metadata files in your repository:
@@ -136,6 +150,8 @@ The module provides several functions for advanced scenarios:
 - `Test-AnyFiles`: Tests for existence of files matching a pattern
 - `Get-GitLineEnding`: Determines correct line endings based on git config
 - `Set-GitIdentity`: Configures git user identity for automated operations
+- `Write-InformationStream`: Streams output to the information stream
+- `Invoke-ExpressionWithLogging`: Executes commands with proper logging
 
 ## Line Ending Handling
 
@@ -145,6 +161,15 @@ The module respects git's line ending settings when generating files:
 2. Falls back to `core.autocrlf` setting
 3. Defaults to OS-specific line endings if no git settings are found
 
+## Git Status Handling
+
+The module carefully handles git status to prevent empty commits:
+
+1. Only attempts commits when there are actual changes
+2. Properly captures and interprets the git status output
+3. Reports clear status messages during metadata updates
+4. Preserves the correct commit hash for both success and no-change scenarios
+
 ## Contributing
 
 1. Fork the repository