Functions/GenXdev.Coding/ReleaseNotes.ps1
|
############################################################################### <# .SYNOPSIS Displays ReleaseNotes from a README.md file. .DESCRIPTION Shows all ReleaseNotes from the "## ReleaseNotes" section of a README.md file. Can use either the README in the current location, PowerShell profile directory, or OneDrive directory. .PARAMETER UseHomeREADME Use README.md from PowerShell profile directory instead of current location. .PARAMETER UseOneDriveREADME Use README.md from OneDrive directory instead of current location. .EXAMPLE ReleaseNotes -UseHomeREADME #> function ReleaseNotes { [CmdletBinding()] param( ####################################################################### [Parameter( Position = 0, Mandatory = $false, HelpMessage = "Use README in PowerShell profile directory" )] [switch] $UseHomeREADME, ####################################################################### [Parameter( Position = 1, Mandatory = $false, HelpMessage = "Use README in OneDrive directory" )] [switch] $UseOneDriveREADME ####################################################################### ) begin { Write-Verbose "Starting ReleaseNotes function" } process { # display ReleaseNotes using base function Add-ReleaseNoteLineToREADME ` -Show ` -UseHomeREADME:$UseHomeREADME ` -UseOneDriveREADME:$UseOneDriveREADME } end { } } |