Skip to content

Commit

Permalink
Prepare for 0.6.2 relase (#69)
Browse files Browse the repository at this point in the history
### Changed

- Bump Pester to latest 5.6.1

### Fixed

- [**#52**](#52) Pester
object wasn't being passed back after running tests, causing the Pester
task to never fail (via [@webtroter](https://github.com/webtroter))
- [**#55**](#55) Add
`-Module` parameter to `Build-PSBuildUpdatableHelp` (via
[@IMJLA](https://github.com/IMJLA))
- [**#60**](#60) Fix
Windows PowerShell compatibility in `Initialize-PSBuild` (via
[@joshooaj](https://github.com/joshooaj))
- [**#62**](#62) Fix code
coverage output fle format not working (via
[@OpsM0nkey](https://github.com/OpsM0nkey))
  • Loading branch information
HeyItsGilbert authored Oct 6, 2024
1 parent acf7815 commit 5266473
Show file tree
Hide file tree
Showing 3 changed files with 95 additions and 43 deletions.
6 changes: 6 additions & 0 deletions .markdownlint.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
{
"$schema": "https://raw.githubusercontent.com/DavidAnson/vscode-markdownlint/refs/heads/main/markdownlint-config-schema.json",
"MD024": {
"siblings_only": true
}
}
94 changes: 70 additions & 24 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,18 +1,30 @@
# Change Log
# Changelog

All notable changes to this project will be documented in this file.

The format is based on [Keep a Changelog](http://keepachangelog.com/)
and this project adheres to [Semantic Versioning](http://semver.org/).

## [0.6.2] Unreleased
## [0.6.2] 2024-10-06

### Changed

- Bump Pester to latest 5.6.1

### Fixed

- [**#52**](https://github.com/psake/PowerShellBuild/pull/52) Pester object wasn't being passed back after running tests, causing the Pester task to never fail (via [@webtroter](https://github.com/webtroter))
- [**#55**](https://github.com/psake/PowerShellBuild/pull/55) Add `-Module` parameter to `Build-PSBuildUpdatableHelp` (via [@IMJLA](https://github.com/IMJLA))
- [**#60**](https://github.com/psake/PowerShellBuild/pull/60) Fix Windows PowerShell compatibility in `Initialize-PSBuild` (via [@joshooaj](https://github.com/joshooaj))
- [**#62**](https://github.com/psake/PowerShellBuild/pull/62) Fix code coverage output fle format not working (via [@OpsM0nkey](https://github.com/OpsM0nkey))
- [**#52**](https://github.com/psake/PowerShellBuild/pull/52) Pester object
wasn't being passed back after running tests, causing the Pester task to never
fail (via [@webtroter](https://github.com/webtroter))
- [**#55**](https://github.com/psake/PowerShellBuild/pull/55) Add `-Module`
parameter to `Build-PSBuildUpdatableHelp` (via
[@IMJLA](https://github.com/IMJLA))
- [**#60**](https://github.com/psake/PowerShellBuild/pull/60) Fix Windows
PowerShell compatibility in `Initialize-PSBuild` (via
[@joshooaj](https://github.com/joshooaj))
- [**#62**](https://github.com/psake/PowerShellBuild/pull/62) Fix code coverage
output fle format not working (via
[@OpsM0nkey](https://github.com/OpsM0nkey))

## [0.6.1] 2021-03-14

Expand All @@ -24,54 +36,78 @@ and this project adheres to [Semantic Versioning](http://semver.org/).

### Changed

- [**#50**](https://github.com/psake/PowerShellBuild/pull/50) Invoke-Build tasks brought inline with psake equivalents (via [@JustinGrote](https://github.com/JustinGrote))
- [**#50**](https://github.com/psake/PowerShellBuild/pull/50) Invoke-Build tasks
brought inline with psake equivalents (via
[@JustinGrote](https://github.com/JustinGrote))

## [0.5.0] 2021-02-27

### Added

- New code coverage parameters for setting output path and format:
- `$PSBPreference.Test.CodeCoverage.OutputFile` - Output file path for code coverage results
- `$PSBPreference.Test.CodeCoverage.OutputFileFormat` - Code coverage output format
- `$PSBPreference.Test.CodeCoverage.OutputFile` - Output file path for code
coverage results
- `$PSBPreference.Test.CodeCoverage.OutputFileFormat` - Code coverage output
format

## [0.5.0] (beta1) - 2020-11-15

### Added

- When "compiling" a monolithic PSM1, add support for both inserting headers/footers for the entire PSM1, and for each script file. Control these via the following new build parameters (via [@pauby](https://github.com/pauby))
- When "compiling" a monolithic PSM1, add support for both inserting
headers/footers for the entire PSM1, and for each script file. Control these
via the following new build parameters (via
[@pauby](https://github.com/pauby))
- `$PSBPreference.Build.CompileHeader`
- `$PSBPreference.Build.CompileFooter`
- `$PSBPreference.Build.CompileScriptHeader`
- `$PSBPreference.Build.CompileScriptFooter`

- Add ability to import project module from output directory prior to executing Pester tests. Toggle this with `$PSBPreference.Test.ImportModule`. Defaults to `$false`. (via [@joeypiccola](https://github.com/joeypiccola))
- Add ability to import project module from output directory prior to executing
Pester tests. Toggle this with `$PSBPreference.Test.ImportModule`. Defaults to
`$false`. (via [@joeypiccola](https://github.com/joeypiccola))

- Use `$PSBPreference.Build.CompileDirectories` to control directories who's contents will be concatenated into the PSM1 when `$PSBPreference.Build.CompileModule` is `$true`. Defaults to `@('Enum', 'Classes', 'Private', 'Public')`.
- Use `$PSBPreference.Build.CopyDirectories` to control directories that will be copied "as is" into the built module. Default is an empty array.
- Use `$PSBPreference.Build.CompileDirectories` to control directories who's
contents will be concatenated into the PSM1 when
`$PSBPreference.Build.CompileModule` is `$true`. Defaults to
`@('Enum', 'Classes', 'Private', 'Public')`.
- Use `$PSBPreference.Build.CopyDirectories` to control directories that will be
copied "as is" into the built module. Default is an empty array.

### Changed

- `$PSBPreference.Build.Exclude` now should be a list of regex expressions when `$PSBPreference.Build.CompileModule` is `$false` (default).
- `$PSBPreference.Build.Exclude` now should be a list of regex expressions when
`$PSBPreference.Build.CompileModule` is `$false` (default).

- Use Pester v5

### Fixed

- Overriding `$PSBPreference.Build.OutDir` now correctly determines the final module output directory. `$PSBPreference.Build.ModuleOutDir` is now computed internally and **SHOULD NOT BE SET DIRECTLY**. ` $PSBPreference.Build.OutDir` will accept both relative and fully-qualified paths.
- Overriding `$PSBPreference.Build.OutDir` now correctly determines the final
module output directory. `$PSBPreference.Build.ModuleOutDir` is now computed
internally and **SHOULD NOT BE SET DIRECTLY**. `$PSBPreference.Build.OutDir`
will accept both relative and fully-qualified paths.

- Before, when `$PSBPreference.Build.CompileModule` was set to `$true`, any files listed in `$PSBPreference.Build.Exclude` weren't being excluded like they should have been. Now, when it is `$true`, files matching regex expressions in `$PSBPreference.Build.Exclude` will be properly excluded (via [@pauby](https://github.com/pauby))
- Before, when `$PSBPreference.Build.CompileModule` was set to `$true`, any
files listed in `$PSBPreference.Build.Exclude` weren't being excluded like
they should have been. Now, when it is `$true`, files matching regex
expressions in `$PSBPreference.Build.Exclude` will be properly excluded (via
[@pauby](https://github.com/pauby))

- `$PSBPreference.Help.DefaultLocale` now defaults to `en-US` on Linux since it is not correctly determined with `Get-UICulture`.
- `$PSBPreference.Help.DefaultLocale` now defaults to `en-US` on Linux since it
is not correctly determined with `Get-UICulture`.

## [0.4.0] - 2019-08-31

### Changed

- Allow using both `Credential` and `ApiKey` when publishing a module (via [@pauby](https://github.com/pauby))
- Allow using both `Credential` and `ApiKey` when publishing a module (via
[@pauby](https://github.com/pauby))

### Fixed

- Don't overwrite Pester parameters when specifying `OutputPath` or `OutputFormat` (via [@ChrisLGardner](https://github.com/ChrisLGardner))
- Don't overwrite Pester parameters when specifying `OutputPath` or
`OutputFormat` (via [@ChrisLGardner](https://github.com/ChrisLGardner))

## [0.3.1] - 2019-06-09

Expand All @@ -83,31 +119,41 @@ and this project adheres to [Semantic Versioning](http://semver.org/).

### Fixed

- [**#24**](https://github.com/psake/PowerShellBuild/pull/24) Fix case of 'Public' folder when dot sourcing functions in PSM1 (via [@pauby](https://github.com/pauby))
- [**#24**](https://github.com/psake/PowerShellBuild/pull/24) Fix case of
'Public' folder when dot sourcing functions in PSM1 (via
[@pauby](https://github.com/pauby))

### Changed

- [**#19**](https://github.com/psake/PowerShellBuild/pull/19) Allow the `BHBuildOutput` environment variable defined by `BuildHelpers` to be set via the `$PSBPreference.Build.ModuleOutDir` property of the build tasks (via [@pauby](https://github.com/pauby))
- [**#19**](https://github.com/psake/PowerShellBuild/pull/19) Allow the
`BHBuildOutput` environment variable defined by `BuildHelpers` to be set via
the `$PSBPreference.Build.ModuleOutDir` property of the build tasks (via
[@pauby](https://github.com/pauby))

### Breaking changes

- Refactor build properties into a single hashtable `$PSBPreference`

### Changed

- [**#11**](https://github.com/psake/PowerShellBuild/pull/11) The Invoke-Build tasks are now auto-generated from the psake tasks via a converter script (via [@JustinGrote](https://github.com/JustinGrote))
- [**#11**](https://github.com/psake/PowerShellBuild/pull/11) The Invoke-Build
tasks are now auto-generated from the psake tasks via a converter script (via
[@JustinGrote](https://github.com/JustinGrote))

## [0.2.0] - 2018-11-15

### Added

- Add `Publish` task to publish the module to the defined PowerShell Repository (PSGallery by default).
- Add `Publish` task to publish the module to the defined PowerShell Repository
(PSGallery by default).

## [0.1.1] - 2018-11-09

### Fixed

- [**#4**](https://github.com/psake/PowerShellBuild/pull/4) Fix syntax for `Analyze` task in `IB.tasks.ps1` (via [@nightroman](https://github.com/nightroman))
- [**#4**](https://github.com/psake/PowerShellBuild/pull/4) Fix syntax for
`Analyze` task in `IB.tasks.ps1` (via
[@nightroman](https://github.com/nightroman))

## [0.1.0] - 2018-11-07

Expand Down
38 changes: 19 additions & 19 deletions PowerShellBuild/PowerShellBuild.psd1
Original file line number Diff line number Diff line change
@@ -1,17 +1,17 @@
@{
RootModule = 'PowerShellBuild.psm1'
ModuleVersion = '0.6.2'
GUID = '15431eb8-be2d-4154-b8ad-4cb68a488e3d'
Author = 'Brandon Olin'
CompanyName = 'Community'
Copyright = '(c) Brandon Olin. All rights reserved.'
Description = 'A common psake and Invoke-Build task module for PowerShell projects'
RootModule = 'PowerShellBuild.psm1'
ModuleVersion = '0.6.2'
GUID = '15431eb8-be2d-4154-b8ad-4cb68a488e3d'
Author = 'Brandon Olin'
CompanyName = 'Community'
Copyright = '(c) Brandon Olin. All rights reserved.'
Description = 'A common psake and Invoke-Build task module for PowerShell projects'
PowerShellVersion = '3.0'
RequiredModules = @(
@{ModuleName = 'BuildHelpers'; ModuleVersion = '2.0.16'}
@{ModuleName = 'Pester'; ModuleVersion = '5.1.1'}
@{ModuleName = 'platyPS'; ModuleVersion = '0.14.1'}
@{ModuleName = 'psake'; ModuleVersion = '4.9.0'}
RequiredModules = @(
@{ModuleName = 'BuildHelpers'; ModuleVersion = '2.0.16' }
@{ModuleName = 'Pester'; ModuleVersion = '5.6.1' }
@{ModuleName = 'platyPS'; ModuleVersion = '0.14.1' }
@{ModuleName = 'psake'; ModuleVersion = '4.9.0' }
)
FunctionsToExport = @(
'Build-PSBuildMAMLHelp'
Expand All @@ -24,15 +24,15 @@
'Test-PSBuildPester'
'Test-PSBuildScriptAnalysis'
)
CmdletsToExport = @()
CmdletsToExport = @()
VariablesToExport = @()
AliasesToExport = @('*tasks')
PrivateData = @{
AliasesToExport = @('*tasks')
PrivateData = @{
PSData = @{
Tags = @('psake', 'build', 'InvokeBuild')
LicenseUri = 'https://raw.githubusercontent.com/psake/PowerShellBuild/master/LICENSE'
ProjectUri = 'https://github.com/psake/PowerShellBuild'
IconUri = 'https://raw.githubusercontent.com/psake/PowerShellBuild/master/media/psaketaskmodule-256x256.png'
Tags = @('psake', 'build', 'InvokeBuild')
LicenseUri = 'https://raw.githubusercontent.com/psake/PowerShellBuild/master/LICENSE'
ProjectUri = 'https://github.com/psake/PowerShellBuild'
IconUri = 'https://raw.githubusercontent.com/psake/PowerShellBuild/master/media/psaketaskmodule-256x256.png'
ReleaseNotes = 'https://raw.githubusercontent.com/psake/PowerShellBuild/master/CHANGELOG.md'
}
}
Expand Down

0 comments on commit 5266473

Please sign in to comment.