NTFSSecurity/CHANGELOG.md

Changelog

All notable changes to this project are documented in this file.

The format is based on Keep a Changelog. Releases up to 4.2.6 are described in the version history.

Unreleased

Added

• Publish the documentation in the wiki, generated from the Docs folder after every change, with a sidebar that lists all cmdlets
• Link the release notes in the PowerShell Gallery to this changelog

Changed

• Breaking: require Windows PowerShell 5.1 or PowerShell 7, and declare support for both editions in the module manifest (#61); the manifest declared PowerShell 2.0 and .NET Framework 3.5, although the module needs .NET Framework 4.5.2
• Rename the -PassThur parameter of Remove-Item2 to -PassThru; -PassThur still works as an alias (#64)
• Publish the module as a Release build that contains only the module files; 4.2.6 was a Debug build with debug symbols and a copy of System.Management.Automation.dll
• Document every cmdlet with synopsis, description, parameters, examples, inputs, outputs, and notes, checked against the source code
• Rewrite the home, concepts, examples, and contributor pages to match the current cmdlets, including module settings, privileges, and long paths
• Move the version history and the installation instructions from the wiki into the documentation, and complete the version history with the release dates from the PowerShell Gallery, the missing notes for 4.2.2, 4.2.5, and 4.2.6, and detailed notes for 4.2.4

Deprecated

• Deprecate the -PassThur alias of Remove-Item2; use -PassThru

Fixed

• Fix Get-Help, which showed only the syntax: ship the help file en-US\NTFSSecurity.dll-Help.xml generated from the cmdlet documentation, including the links that Get-Help -Online opens, instead of the outdated NTFSSecurity-Help.xml
• Fix documentation examples that did not work, such as restoring permissions from a CSV file and filtering entries by account
• Remove Show-NTFSSimpleAccess, which no longer exists, and duplicate entries from the cmdlets that the module manifest exports and the PowerShell Gallery lists
• Fix Set-NTFSInheritance, which failed with "Nullable object must have a value" when -AccessInheritanceEnabled or -AuditInheritanceEnabled was omitted; an omitted parameter now leaves its section unchanged
• Fix Get-ChildItem2, which stopped with an InvalidCastException when -Path pointed to a file; it now returns the file, like Get-ChildItem
• Fix Get-FileHash2, which stopped at a folder in -Path and didn't hash the files that followed it; folders are now skipped
• Fix Get-NTFSAudit, which returned nothing without the Security privilege instead of an error, and which returned the entries of the previous item again after a path whose security descriptor it couldn't read
• Fix Get-NTFSAccess, which returned the entries of the previous item again after a path whose ACL it couldn't read
• Fix Add-NTFSAudit, whose -Account and -AccessRights parameters were both at position 2, so that positional calls failed; -AccessRights is now at position 3, like in Remove-NTFSAudit (#4)
• Fix -PassThru of Add-NTFSAudit with -SecurityDescriptor and of Remove-NTFSAudit with -Path, which returned access entries; both now return the audit entries
• Fix the InheritanceEnabled property of audit entries, which reported the inheritance of the access entries; it now reports whether the audit entries are inherited
• Fix Get-NTFSInheritance -SecurityDescriptor, which reported AuditInheritanceEnabled as $true for a security descriptor that was read without its audit section; it now reports $null, like -Path
• Fix Get-NTFSOwner, which wrote a "The pipeline has been stopped" error for every path when a command such as Select-Object -First 1 stopped the pipeline, and which repeated a failed read instead of reporting the denied access
• Fix Copy-Item2, which failed with a DirectoryNotFoundException when it copied a folder that contained files
• Fix Disable-Privileges, which couldn't disable the privileges when the module setting EnablePrivileges was $false
• Fix the inheritance cmdlets, which enabled the Backup, Restore, Take Ownership, and Security privileges even when the module setting EnablePrivileges was $false, and left them enabled