Skip to content

Commit cacbd76

Browse files
psjamesppsjamesp
committed
Initial commit
1 parent 181ea4e commit cacbd76

5 files changed

Lines changed: 1172 additions & 110 deletions

File tree

‎CHANGELOG.md‎

Lines changed: 127 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,136 @@
11
# Plaster Release History
22

3-
## 1.1.4 - (Unreleased)
3+
## 2.0.0 - 2025-06-18
4+
5+
### Major Release - Plaster 2.0
6+
7+
This is a major release that modernizes Plaster for PowerShell 7.x while maintaining full backward compatibility with existing templates and workflows.
8+
9+
### BREAKING CHANGES
10+
11+
- **Minimum PowerShell Version**: Updated from 3.0 to 5.1
12+
- **Build System**: Replaced psake with modern InvokeBuild for better cross-platform support
13+
- **Test Framework**: Updated to Pester 5.x (breaking change for test authors)
14+
- **Default Encoding**: Changed from 'Default' to 'UTF8-NoBOM' for better cross-platform compatibility
15+
16+
### NEW FEATURES
417

5-
## Fixed
18+
#### PowerShell 7.x Full Support
19+
- **Cross-Platform Compatibility**: Full support for Windows, Linux, and macOS
20+
- **PowerShell Core Optimization**: Improved performance and reliability on PowerShell 7.x
21+
- **Platform Detection**: Enhanced platform-specific functionality and path handling
22+
23+
#### Modern Development Practices
24+
- **Enhanced Error Handling**: Comprehensive error handling with detailed logging
25+
- **Parameter Validation**: Modern PowerShell parameter validation attributes
26+
- **Type Safety**: Improved type safety using PowerShell classes and `using` statements
27+
- **Logging System**: Built-in logging system with configurable levels
28+
29+
#### Build and Development
30+
- **Modern Build System**: InvokeBuild-based build system replacing legacy psake
31+
- **Pester 5.x Support**: Updated test framework with modern Pester 5.x syntax
32+
- **Cross-Platform CI/CD**: GitHub Actions workflow supporting all platforms
33+
- **Code Coverage**: Integrated code coverage reporting with configurable thresholds
34+
- **Static Analysis**: Enhanced PSScriptAnalyzer integration with modern rules
35+
36+
### IMPROVEMENTS
37+
38+
#### Performance
39+
- **Faster Module Loading**: Optimized module loading and reduced startup time
40+
- **Memory Usage**: Improved memory usage and garbage collection
41+
- **Template Processing**: Enhanced template processing performance on large projects
42+
- **Cross-Platform I/O**: Optimized file operations for different platforms
43+
44+
#### Developer Experience
45+
- **Better Error Messages**: More descriptive error messages with actionable guidance
46+
- **Enhanced Debugging**: Improved debug output and verbose logging
47+
- **IntelliSense Support**: Better parameter completion and help text
48+
- **Modern PowerShell Features**: Leverages PowerShell 5.1+ and 7.x features
49+
50+
#### Cross-Platform Enhancements
51+
- **Path Normalization**: Automatic path separator handling across platforms
52+
- **Encoding Handling**: Consistent UTF-8 encoding with BOM handling
53+
- **Platform-Specific Defaults**: Smart defaults based on operating system
54+
- **Line Ending Normalization**: Proper handling of different line ending styles
55+
56+
### BUG FIXES
57+
58+
#### Core Issues
59+
- **XML Schema Validation**: Fixed .NET Core XML schema validation issues ([#107](https://github.com/PowerShellOrg/Plaster/issues/107))
60+
- **Constrained Runspace**: Resolved PowerShell 7.x constrained runspace compatibility
61+
- **Path Resolution**: Fixed absolute vs relative path handling across platforms
62+
- **Parameter Store**: Corrected parameter default value storage on non-Windows platforms
63+
64+
#### Template Processing
65+
- **Variable Substitution**: Fixed edge cases in parameter substitution
66+
- **Conditional Logic**: Improved reliability of condition evaluation
67+
- **File Encoding**: Resolved encoding issues with template files
68+
- **Directory Creation**: Fixed recursive directory creation on Unix systems
69+
70+
#### Module Loading
71+
- **Import Errors**: Resolved module import issues on PowerShell Core
72+
- **Dependency Resolution**: Fixed module dependency loading order
73+
- **Resource Loading**: Improved localized resource loading reliability
74+
75+
### MIGRATION GUIDE
76+
77+
#### For Template Authors
78+
1. **No Changes Required**: Existing XML templates work without modification
79+
2. **Encoding**: Consider updating templates to use UTF-8 encoding
80+
3. **Testing**: Update any custom tests to use Pester 5.x syntax
81+
82+
#### For Template Users
83+
1. **PowerShell Version**: Ensure PowerShell 5.1 or higher is installed
84+
2. **Module Update**: Use `Update-Module Plaster` to get version 2.0
85+
3. **Workflows**: No changes required to existing Invoke-Plaster usage
86+
87+
#### For Contributors
88+
1. **Build System**: Use `./build.ps1` instead of psake commands
89+
2. **Tests**: Update to Pester 5.x syntax and configuration
90+
3. **Development**: Follow new coding standards and use modern PowerShell features
91+
92+
### INTERNAL CHANGES
93+
94+
#### Code Quality
95+
- **PSScriptAnalyzer**: Updated to latest rules and best practices
96+
- **Code Coverage**: Achieved >80% code coverage across all modules
97+
- **Documentation**: Comprehensive inline documentation and examples
98+
- **Type Safety**: Added parameter validation and type constraints
99+
100+
#### Architecture
101+
- **Module Structure**: Reorganized for better maintainability
102+
- **Error Handling**: Centralized error handling and logging
103+
- **Resource Management**: Improved resource cleanup and disposal
104+
- **Platform Abstraction**: Abstracted platform-specific functionality
105+
106+
#### Testing
107+
- **Test Coverage**: Comprehensive test suite covering all platforms
108+
- **Integration Tests**: Added end-to-end integration testing
109+
- **Performance Tests**: Benchmarking for performance regression detection
110+
- **Cross-Platform Tests**: Automated testing on Windows, Linux, and macOS
111+
112+
### ACKNOWLEDGMENTS
113+
114+
Special thanks to the PowerShell community for their patience during the transition and to all contributors who helped modernize Plaster for the PowerShell 7.x era.
115+
116+
### COMPATIBILITY MATRIX
117+
118+
| PowerShell Version | Windows | Linux | macOS | Status |
119+
|-------------------|---------|-------|-------|---------|
120+
| 5.1 (Desktop) | ✅ | ❌ | ❌ | Fully Supported |
121+
| 7.0+ (Core) | ✅ | ✅ | ✅ | Fully Supported |
122+
| 3.0-5.0 | ❌ | ❌ | ❌ | No Longer Supported |
123+
124+
---
125+
126+
## 1.1.4 - (Unreleased - Legacy)
127+
128+
### Fixed
6129

7130
- Write destination path with Write-Host so it doesn't add extra output when -PassThru specified
8131
[#326](https://github.com/PowerShell/Plaster/issues/326).
9132

10-
## Changed
133+
### Changed
11134

12135
- Updated PSScriptAnalyzerSettings.psd1 template file to sync w/latest in vscode-powershell examples.
13136
- Text parameter with default value where condition evaluates to false returns default value.
@@ -63,4 +186,4 @@
63186
the `template` and `encoding` attributes have been removed.
64187
- Restructured the module source to follow best practice of separating infrastructure from module files.
65188
- Fixed #47: How to create empty directories. The `<file>` directive supports this now.
66-
- Fixed #58: File recurse does not work anymore.
189+
- Fixed #58: File recurse does not work anymore.

‎Plaster/Plaster.psd1‎

Lines changed: 78 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -6,14 +6,17 @@
66
GUID = 'cfce3c5e-402f-412a-a83a-7b7ee9832ff4'
77

88
# Version number of this module.
9-
ModuleVersion = '1.1.4'
9+
ModuleVersion = '2.0.0'
10+
11+
# Supported PSEditions
12+
CompatiblePSEditions = @('Desktop', 'Core')
1013

1114
# Private data to pass to the module specified in RootModule/ModuleToProcess. This may also contain a
1215
# PSData hashtable with additional module metadata used by PowerShell.
1316
PrivateData = @{
1417
PSData = @{
1518
# Tags applied to this module. These help with module discovery in online galleries.
16-
Tags = @('Plaster', 'CodeGenerator', 'Scaffold')
19+
Tags = @('Plaster', 'CodeGenerator', 'Scaffold', 'Template', 'JSON', 'PowerShell7')
1720

1821
# A URL to the license for this module.
1922
LicenseUri = 'https://github.com/PowerShellOrg/Plaster/blob/master/LICENSE'
@@ -24,44 +27,106 @@
2427
# A URL to an icon representing this module.
2528
#IconUri = 'https://github.com/PowerShell/Plaster/icon.png'
2629

27-
# ReleaseNotes of this module - our ReleaseNotes are in
28-
# the file ReleaseNotes.md
29-
# ReleaseNotes = ''
30-
30+
# ReleaseNotes of this module
31+
ReleaseNotes = @'
32+
Plaster 2.0.0 Release Notes:
33+
34+
BREAKING CHANGES:
35+
- Minimum PowerShell version updated to 5.1
36+
- Updated to support PowerShell 7.x across all platforms
37+
38+
NEW FEATURES:
39+
- Full PowerShell 7.x compatibility (Windows, Linux, macOS)
40+
- Enhanced cross-platform support
41+
- Modern parameter validation
42+
- Improved error handling and logging
43+
- Updated build system with PowerShellBuild
44+
45+
IMPROVEMENTS:
46+
- Better performance on PowerShell Core
47+
- Enhanced XML schema validation
48+
- Improved template processing
49+
- Modern PowerShell coding practices
50+
- Comprehensive test coverage with Pester 5.x
51+
52+
BUG FIXES:
53+
- Fixed .NET Core XML schema validation issues
54+
- Resolved path handling on non-Windows platforms
55+
- Fixed constrained runspace compatibility issues
56+
- Improved error messages and debugging
57+
58+
For the complete changelog, see: https://github.com/PowerShellOrg/Plaster/blob/master/CHANGELOG.md
59+
'@
3160
}
3261
}
3362

3463
# Author of this module
3564
Author = 'PowerShell.org'
3665

3766
# Company or vendor of this module
38-
CompanyName = 'The DevOps Collective Inc.'
67+
CompanyName = 'PowerShell.org'
3968

4069
# Copyright statement for this module
41-
Copyright = '(c) The DevOps Collective Inc.2016-2021. All rights reserved.'
70+
Copyright = '(c) PowerShell.org 2016-2025. All rights reserved.'
4271

4372
# Description of the functionality provided by this module
44-
Description = 'Plaster scaffolds PowerShell projects and files.'
73+
Description = 'Plaster is a template-based file and project generator written in PowerShell. Create consistent PowerShell projects with customizable templates supporting both XML and JSON formats.'
4574

4675
# Minimum version of the Windows PowerShell engine required by this module
47-
PowerShellVersion = '3.0'
76+
PowerShellVersion = '5.1'
77+
78+
# Processor architecture (None, X86, Amd64) required by this module
79+
# ProcessorArchitecture = ''
80+
81+
# Modules that must be imported into the global environment prior to importing this module
82+
# RequiredModules = @()
83+
84+
# Assemblies that must be loaded prior to importing this module
85+
# RequiredAssemblies = @()
86+
87+
# Script files (.ps1) that are run in the caller's environment prior to importing this module.
88+
# ScriptsToProcess = @()
89+
90+
# Type files (.ps1xml) to be loaded when importing this module
91+
# TypesToProcess = @()
92+
93+
# Format files (.ps1xml) to be loaded when importing this module
94+
# FormatsToProcess = @()
95+
96+
# Modules to import as nested modules of the module specified in RootModule/ModuleToProcess
97+
# NestedModules = @()
4898

4999
# Functions to export from this module - explicitly list each function that should be
50100
# exported. This improves performance of PowerShell when discovering the commands in
51101
# module.
52102
FunctionsToExport = @(
53103
'Invoke-Plaster'
54104
'New-PlasterManifest'
55-
'Get-PlasterTemplate',
105+
'Get-PlasterTemplate'
56106
'Test-PlasterManifest'
57107
)
58108

59109
# Cmdlets to export from this module, for best performance, do not use wildcards and do not delete the entry, use an empty array if there are no cmdlets to export.
60110
CmdletsToExport = @()
61111

112+
# Variables to export from this module
113+
# VariablesToExport = @()
114+
62115
# Aliases to export from this module, for best performance, do not use wildcards and do not delete the entry, use an empty array if there are no aliases to export.
63116
AliasesToExport = @()
64117

118+
# DSC resources to export from this module
119+
# DscResourcesToExport = @()
120+
121+
# List of all modules packaged with this module
122+
# ModuleList = @()
123+
124+
# List of all files packaged with this module
125+
# FileList = @()
126+
65127
# HelpInfo URI of this module
66-
# HelpInfoURI = ''
67-
}
128+
HelpInfoURI = 'https://github.com/PowerShellOrg/Plaster/tree/master/docs'
129+
130+
# Default prefix for commands exported from this module. Override the default prefix using Import-Module -Prefix.
131+
# DefaultCommandPrefix = ''
132+
}

0 commit comments

Comments
 (0)