Whiskey

Author(s)

• WebMD Health Services

Tags

build pipeline devops ci cd continuous-integration continuous-delivery continuous-deploy

Functions

Add-WhiskeyApiKey Add-WhiskeyCredential Add-WhiskeyTaskDefault Add-WhiskeyVariable Assert-WhiskeyNodePath Assert-WhiskeyNodeModulePath ConvertFrom-WhiskeyContext ConvertFrom-WhiskeyYamlScalar ConvertTo-WhiskeyContext ConvertTo-WhiskeySemanticVersion Convert-WhiskeyPathDirectorySeparator Get-WhiskeyApiKey Get-WhiskeyTask Get-WhiskeyCredential Get-WhiskeyMSBuildConfiguration Install-WhiskeyTool Invoke-WhiskeyNodeTask Invoke-WhiskeyNpmCommand Invoke-WhiskeyPipeline Invoke-WhiskeyBuild Invoke-WhiskeyTask New-WhiskeyContext Publish-WhiskeyBuildMasterPackage Publish-WhiskeyNuGetPackage Publish-WhiskeyProGetUniversalPackage Publish-WhiskeyBBServerTag Register-WhiskeyEvent Resolve-WhiskeyNodePath Resolve-WhiskeyNodeModulePath Resolve-WhiskeyNuGetPackageVersion Resolve-WhiskeyTaskPath Resolve-WhiskeyVariable Set-WhiskeyBuildStatus Set-WhiskeyMSBuildConfiguration Stop-WhiskeyTask Uninstall-WhiskeyTool Unregister-WhiskeyEvent Write-WhiskeyDebug Write-WhiskeyError Write-WhiskeyInfo Write-WhiskeyObject Write-WhiskeyVerbose Write-WhiskeyWarning

PSEditions

Desktop Core

Dependencies

This module has no dependencies.

Release Notes

## Breaking Changes

* Whiskey's default version number is now `0.0.0` instead of using the current date. If you care about your version number, make sure you have a `Version` task defined in your whiskey.yml file.
* Whiskey's `CopyFile`, `Delete`, `DotNet`, `File`, `LoadTask`, `GetPowerShellModule`, `GitHubRelease`, `MergeFile`, `MSBuild`, `NuGetPack`, `NuGetPush`, `NuGetRestore`, `NUnit2`, `NUnit3`, `Pester3`, `PowerShell`, `ProGetUniversalPackage`, `PublishPowerShellModule`, `PublishProGetUniversalPackage`, `SetVariableFromPowerShellDataFile`, `SetVariableFromXml`, `Version`, and `Zip` tasks now resolve paths relative to their working directories instead of the build root. If you use a `WorkingDirectory` property on any of these tasks, make sure the values to their path properties are relative to that working directory.
* Whiskey now passes relative paths to tasks. Task authors may need to update their tasks to support this.
* The `Resolve-WhiskeyTaskPath` function's parameters have changed. If you use `Resolve-WhiskeyTaskPath`, you'll need to update your usages to use the new parameters.
* Removed all support for old "VersionFrom", "PrereleaseMap", and "Version" properties in the root of your whiskey.yml file. Use Whiskey's `Version` task instead.

## Improvements and Bug Fixes
* The `GetPowerShellModule` task now supports installing prerelease versions of modules. Set the `AllowPrerelease` property to `true`.
* The `GetPowerShellModule` task can now install a module into a custom directory instead of the PSModules directory. Pass the path to the `Path` parameter.
* The `GetPowerShellModule` task can now import the module being installed. Set the `Import` property to `true`.
* Fixed: Whiskey fails to fail a build when certain PowerShell terminating errors are thrown (i.e. strict mode violations, command not found error, etc.).
* The `SourceRoot` property on the `ProGetUniversalPackage` and `Zip` tasks is deprecated. Use `WorkingDirectory` instead.
* Added support to the `Pester4` task for passing arbitrary parameters to Invoke-Pester. Pass the parameters as named properties via the new `Argument` property.
* Created `Write-WhiskeyObject` function for writing objects in sensible ways. Currently, only hashtables/dictionaries are supported. Keys/values are printed so they align and are recognizable. Other objects are passed to PowerShell's `Out-String` for formatting.
* Created `Convert-WhiskeyPathDirectorySeparator` for converting the directory separators in a path to the separator for the current platform.