Sampler

0.117.0-preview0003

Sample Module with Pipeline scripts and its Plaster template to create a module following some of the community accepted practices.

Minimum PowerShell version

5.0

This is a prerelease version of Sampler.
There is a newer prerelease version of this module available.
See the version list below for details.

Installation Options

Copy and Paste the following command to install this package using PowerShellGet More Info

Install-Module -Name Sampler -RequiredVersion 0.117.0-preview0003 -AllowPrerelease

Copy and Paste the following command to install this package using Microsoft.PowerShell.PSResourceGet More Info

Install-PSResource -Name Sampler -Version 0.117.0-preview0003 -Prerelease

You can deploy this package directly to Azure Automation. Note that deploying packages with dependencies will deploy all the dependencies to Azure Automation. Learn More

Manually download the .nupkg file to your system's default download location. Note that the file won't be unpacked, and won't include any dependencies. Learn More

Owners

Copyright

(c) Gael Colas. All rights reserved.

Package Details

Author(s)

  • Gael Colas

Tags

Template pipeline plaster DesiredStateConfiguration DSC DSCResourceKit DSCResource Windows MacOS Linux

Functions

Add-Sample Convert-SamplerHashtableToString Get-BuildVersion Get-BuiltModuleVersion Get-ClassBasedResourceName Get-CodeCoverageThreshold Get-MofSchemaName Get-OperatingSystemShortName Get-PesterOutputFileFileName Get-Psm1SchemaName Get-SamplerAbsolutePath Get-SamplerBuiltModuleBase Get-SamplerBuiltModuleManifest Get-SamplerCodeCoverageOutputFile Get-SamplerCodeCoverageOutputFileEncoding Get-SamplerModuleInfo Get-SamplerModuleRootPath Get-SamplerProjectName Get-SamplerSourcePath Invoke-SamplerGit Merge-JaCoCoReport New-SampleModule New-SamplerJaCoCoDocument New-SamplerPipeline Out-SamplerXml Set-SamplerPSModulePath Split-ModuleVersion Update-JaCoCoStatistic

Dependencies

Release Notes

## [0.117.0-preview0003] - 2023-09-24

### Added

- Integration tests to build and import a module created using the Plaster
 template _SimpleModule_.
- Support [ModuleFast](https://github.com/JustinGrote/ModuleFast) when
 restoring dependencies by adding the parameter `UseModuleFast` to the
 `build.ps1`, e.g. `./build.ps1 -Tasks noop -ResolveDependency -UseModuleFast`
 or by enabling it in the configuration file Resolve-Dependency.psd1.
 Using ModuleFast will resolve dependencies much faster, but requires
 PowerShell 7.2.
- Support for [PSResourceGet (beta release)](https://github.com/PowerShell/PSResourceGet).
 If the modules PSResourceGet can be bootstrapped they will be used. If
 PSResourceGet cannot be bootstrapped then it will revert to using
 PowerShellGet v2.2.5. If the user requests or configures to use ModuleFast
 then that will override both PSResourceGet and PowerShellGet. The method
 PSResourceGet can be enabled in the configuration file Resolve-Dependency.psd1.
 It is also possible to use PSResourceGet by adding the parameter `UsePSResourceGet`
 to the `build.ps1`, e.g. `./build.ps1 -Tasks noop -ResolveDependency -UsePSResourceGet`.
- When using PSResourceGet to resolve dependencies it also possible to
 use PowerShellGet v2.9.0 (previous _CompatPowerShellGet_). To use the
 compatibility module it can be enabled in the configuration file Resolve-Dependency.psd1.
 It is also possible to use it by adding the parameter `UsePowerShellGetCompatibilityModule`
 to the `build.ps1`, e.g. `./build.ps1 -Tasks noop -ResolveDependency -UsePSResourceGet -UsePowerShellGetCompatibilityModule`.
 _The 2.9.0-preview has since then been unlisted, the compatibility_
 _module will now be released as PowerShellGet v3.0.0._

### Changed

- Task `publish_nupkg_to_gallery`
 - Add support for publishing a NuGet package to a gallery using the .NET SDK in addition to using nuget.exe. Fixes [#433](https://github.com/gaelcolas/Sampler/issues/433)
- Split up unit tests and integration tests in separate pipeline jobs since
 integration tests could change state on a developers machine, and in the
 current PowerShell session. Integration tests no longer run when running
 `./build.ps1 -Tasks test`. To run integration tests pass the parameter
 `PesterPath`, e.g. `./build.ps1 -Tasks test -PesterPath 'tests/Integration'`.
- Added sample private function and public function samples to Plaster template
 _SimpleModule_ so that it is possible to run task `test` without it failing.
- Sample Private function tests updated to Pester 5.
- Sample Public function tests updated to Pester 5.
- Sampler's build.ps1 and the template build.ps1 was aligned.
- PowerShell Team will release the PSResourceGet compatibility module
 (previously known as CompatPowerShellGet) as PowerShellGet v2.9.0 (or
 higher). The resolve dependency script, when PowerShellGet is used, will
 use `MaximumVersion` set to `2.8.999` to make sure the expected
 PowerShellGet version is installed, today that it is v2.2.5.
 _The 2.9.0-preview has since then been unlisted, the compatibility_
 _module will now be released as PowerShellGet v3.0.0._

### Fixed

- Fix unit tests that was wrongly written and failed on Pester 5.5.
- There was different behavior on PowerShell and Windows PowerShell when
 creating the module manifest. So when the `modify` section that was meant
 to reuse the already present but commented `Prerelease` key it also ran
 the `modify` statement that adds a `Prerelease` key that is needed for
 a module manifest that is created under Windows PowerShell. This resulted
 in two `Prerelease` keys when creating a module under PowerShell 7.x.
 Now it will add a commented `Perelease` key and then next `modify` statement
 will remove the comment, making it work on all version of PowerShell.
 Fixes [#436](https://github.com/gaelcolas/Sampler/issues/436).
- The QA test template was updated so that it is possible to run the tests
 without the need to add a git remote (remote `origin`).

FileList

Version History

Version Downloads Last updated
0.118.2-prev... 1,356 8/26/2024
0.118.2-prev... 1,214 7/28/2024
0.118.2-prev... 213 7/24/2024
0.118.1 78,814 7/20/2024
0.118.1-prev... 7 7/18/2024
0.118.1-prev... 5 7/17/2024
0.118.0-prev... 3,696 4/17/2024
0.118.0-prev... 373 4/6/2024
0.118.0-prev... 1,186 2/9/2024
0.118.0-prev... 1,078 1/13/2024
0.118.0-prev... 294 1/7/2024
0.117.1-prev... 5 1/7/2024
0.117.1-prev... 503 12/24/2023
0.117.0 170,476 9/29/2023
0.117.0-prev... (current version) 193 9/24/2023
0.117.0-prev... 26 9/21/2023
0.117.0-prev... 1,633 7/1/2023
0.116.6-prev... 5 6/30/2023
0.116.5 84,206 4/19/2023
0.116.5-prev... 165 4/17/2023
0.116.4 3,243 4/6/2023
0.116.4-prev... 6 4/6/2023
0.116.3 1,606 4/1/2023
0.116.3-prev... 5 4/1/2023
0.116.3-prev... 639 3/7/2023
0.116.2 10,704 3/1/2023
0.116.2-prev... 8 3/1/2023
0.116.2-prev... 1,049 1/24/2023
0.116.1 11,936 1/9/2023
0.116.0 26,850 11/8/2022
0.116.0-prev... 14 11/8/2022
0.116.0-prev... 35 11/1/2022
0.116.0-prev... 10 11/1/2022
0.116.0-prev... 11 11/1/2022
0.116.0-prev... 10 11/1/2022
0.116.0-prev... 790 8/3/2022
0.116.0-prev... 12 8/1/2022
0.116.0-prev... 752 7/9/2022
0.115.0 4,713 6/9/2022
0.115.0-prev... 455 5/29/2022
0.115.0-prev... 10 5/28/2022
0.115.0-prev... 131 5/23/2022
0.115.0-prev... 52 5/21/2022
0.115.0-prev... 50 5/20/2022
0.114.1-prev... 22 5/20/2022
0.114.0 1,470 5/13/2022
0.113.0-prev... 11 5/13/2022
0.112.4-prev... 27 5/13/2022
0.112.4-prev... 20 5/13/2022
0.112.3 1,770 3/31/2022
0.112.3-prev... 10 3/31/2022
0.112.2 535 3/20/2022
0.112.2-prev... 11 3/20/2022
0.112.2-prev... 828 2/16/2022
0.112.2-prev... 272 1/26/2022
0.112.1 2,406 1/23/2022
0.112.1-prev... 10 1/23/2022
0.112.1-prev... 10 1/23/2022
0.112.1-prev... 10 1/23/2022
0.112.1-prev... 309 12/1/2021
0.112.1-prev... 142 11/15/2021
0.112.1-prev... 163 10/1/2021
0.112.0 4,291 9/23/2021
0.112.0-prev... 20 9/8/2021
0.112.0-prev... 10 9/8/2021
0.112.0-prev... 13 9/5/2021
0.112.0-prev... 49 8/18/2021
0.111.8 1,312 8/8/2021
0.111.8-prev... 15 8/7/2021
0.111.7 236 7/31/2021
0.111.7-prev... 58 7/30/2021
0.111.7-prev... 73 7/28/2021
0.111.6 678 7/3/2021
0.111.6-prev... 22 7/2/2021
0.111.6-prev... 12 7/1/2021
0.111.5 270 6/25/2021
0.111.5-prev... 11 6/25/2021
0.111.5-prev... 96 6/17/2021
0.111.4 493 6/3/2021
0.111.4-prev... 10 6/3/2021
0.111.3 537 5/21/2021
0.111.3-prev... 10 5/21/2021
0.111.2 30 5/21/2021
0.111.2-prev... 10 5/21/2021
0.111.1 378 5/15/2021
0.111.1-prev... 11 5/15/2021
0.111.1-prev... 11 5/15/2021
0.111.0 196 5/13/2021
0.111.0-prev... 13 5/13/2021
0.111.0-prev... 12 5/13/2021
0.111.0-prev... 12 5/13/2021
0.111.0-prev... 69 5/7/2021
0.111.0-prev... 11 5/6/2021
0.111.0-prev... 20 5/4/2021
0.111.0-prev... 67 4/20/2021
0.111.0-prev... 63 4/16/2021
0.110.2-prev... 25 4/14/2021
0.110.2-prev... 55 4/13/2021
0.110.1 1,001 4/8/2021
0.110.1-prev... 13 4/8/2021
0.110.0 20 4/8/2021
0.110.0-prev... 11 4/8/2021
0.110.0-prev... 11 4/7/2021
0.110.0-prev... 11 4/7/2021
0.110.0-prev... 11 4/7/2021
0.109.11-pre... 19 3/29/2021
0.109.10 667 3/24/2021
0.109.10-pre... 15 3/22/2021
0.109.9 257 3/20/2021
0.109.9-prev... 11 3/20/2021
0.109.8 25 3/20/2021
0.109.8-prev... 12 3/20/2021
0.109.7 18 3/20/2021
0.109.7-prev... 12 3/20/2021
0.109.6 225 3/18/2021
0.109.6-prev... 15 3/18/2021
0.109.6-prev... 19 3/16/2021
0.109.5 377 3/10/2021
0.109.5-prev... 18 3/10/2021
0.109.5-prev... 20 3/10/2021
0.109.5-prev... 40 3/8/2021
0.109.5-prev... 12 3/7/2021
0.109.4 482 3/6/2021
0.109.4-prev... 13 3/6/2021
0.109.3 877 2/16/2021
0.109.3-prev... 13 2/16/2021
0.109.2 857 1/13/2021
0.109.2-prev... 14 1/13/2021
0.109.2-prev... 13 1/13/2021
0.109.1 321 1/6/2021
0.109.1-prev... 13 1/4/2021
0.109.1-prev... 13 12/29/2020
0.109.0 1,116 11/24/2020
0.109.0-prev... 12 11/24/2020
0.109.0-prev... 19 11/19/2020
0.109.0-prev... 13 11/18/2020
0.109.0-prev... 12 10/13/2020
0.108.0 707 9/14/2020
0.108.0-prev... 11 9/13/2020
0.108.0-prev... 10 9/13/2020
0.107.4-prev... 10 9/12/2020
0.107.4-prev... 10 9/11/2020
0.107.3 211 9/10/2020
0.107.3-prev... 10 9/10/2020
0.107.2 206 9/8/2020
0.107.2-prev... 11 9/8/2020
0.107.1 177 9/8/2020
0.107.1-prev... 11 9/7/2020
0.107.0 168 9/7/2020
0.107.0-prev... 10 9/7/2020
0.107.0-prev... 11 9/7/2020
0.106.1 206 8/30/2020
0.106.1-prev... 11 8/30/2020
0.106.0 187 8/30/2020
0.106.0-prev... 11 8/29/2020
0.106.0-prev... 19 8/21/2020
0.106.0-prev... 32 8/19/2020
0.106.0-prev... 12 8/18/2020
0.106.0-prev... 13 8/8/2020
0.105.7-prev... 16 7/11/2020
0.105.6 1,895 6/1/2020
0.105.6-prev... 11 6/1/2020
0.105.5 276 5/29/2020
0.105.5-prev... 12 5/29/2020
0.105.5-prev... 11 5/29/2020
0.105.4 171 5/29/2020
0.105.4-prev... 11 5/29/2020
0.105.4-prev... 11 5/28/2020
0.105.3 858 5/9/2020
0.105.3-prev... 11 5/9/2020
0.105.2 655 5/1/2020
0.105.2-prev... 11 5/1/2020
0.105.2-prev... 11 5/1/2020
0.105.2-prev... 11 4/24/2020
0.105.2-prev... 11 4/24/2020
0.105.1 477 4/24/2020
0.105.1-prev... 11 4/24/2020
0.105.0 298 4/21/2020
0.105.0-prev... 11 4/21/2020
0.105.0-prev... 11 4/18/2020
0.104.0 3,623 4/18/2020
0.104.0-prev... 11 4/18/2020
0.104.0-prev... 11 4/17/2020
0.103.0 206 4/17/2020
0.103.0-prev... 11 4/17/2020
0.102.1 1,332 2/21/2020
0.102.1-prev... 14 2/18/2020
0.102.1-prev... 13 2/18/2020
0.102.0 272 2/14/2020
0.102.0-prev... 14 2/14/2020
0.102.0-prev... 14 2/12/2020
0.101.0 249 2/10/2020
0.101.0-prev... 13 2/10/2020
0.101.0-prev... 13 2/7/2020
0.101.0-prev... 13 2/7/2020
0.100.0 452 2/1/2020
0.100.0-prev... 13 2/1/2020
0.99.4 388 1/22/2020
0.99.4-previ... 15 1/22/2020
0.99.4-previ... 14 1/22/2020
0.99.4-previ... 13 1/22/2020
0.99.3 180 1/21/2020
0.99.3-previ... 13 1/21/2020
0.99.2 297 1/16/2020
0.99.2-previ... 14 1/16/2020
0.99.1 152 1/16/2020
0.99.1-previ... 13 1/16/2020
0.99.1-previ... 15 1/9/2020
0.99.1-previ... 13 1/7/2020
0.99.1-previ... 13 1/7/2020
0.99.0 682 1/1/2020
0.99.0-previ... 13 1/1/2020
0.99.0-previ... 13 1/1/2020
0.99.0-previ... 13 1/1/2020
0.99.0-previ... 17 12/28/2019
0.99.0-previ... 14 12/28/2019
0.99.0-previ... 13 12/26/2019
0.98.1 513 12/24/2019
0.98.1-previ... 14 12/24/2019
0.98.1-previ... 13 12/23/2019
0.98.0 190 12/22/2019
0.98.0-previ... 14 12/22/2019
0.98.0-previ... 14 12/21/2019
0.97.0 448 12/9/2019
0.97.0-previ... 13 12/9/2019
0.96.1-previ... 14 11/8/2019
0.96.1-previ... 13 11/5/2019
0.96.0 338 11/1/2019
0.96.0-previ... 14 11/1/2019
0.95.2-previ... 14 11/1/2019
0.95.1 189 11/1/2019
0.95.1-previ... 13 11/1/2019
0.95.1-previ... 13 11/1/2019
0.95.0 175 11/1/2019
0.95.0-previ... 13 11/1/2019
0.94.0 178 10/30/2019
0.94.0-previ... 14 10/30/2019
0.94.0-previ... 14 10/30/2019
0.93.3-previ... 13 10/30/2019
0.93.2 174 10/30/2019
0.93.2-previ... 13 10/30/2019
0.93.2-previ... 13 10/30/2019
0.93.2-previ... 12 10/29/2019
0.93.1 181 10/29/2019
0.93.1-previ... 14 10/29/2019
0.93.1-previ... 13 10/29/2019
0.93.0 173 10/29/2019
0.93.0-previ... 13 10/29/2019
0.93.0-previ... 13 10/29/2019
0.93.0-previ... 12 10/23/2019
0.93.0-previ... 12 10/23/2019
0.93.0-previ... 20 10/22/2019
0.93.0-previ... 15 10/20/2019
0.92.2-previ... 13 10/15/2019
0.92.1 201 10/15/2019
0.92.1-previ... 12 10/15/2019
0.92.0 172 10/15/2019
0.92.0-previ... 12 10/14/2019
0.92.0-previ... 13 10/14/2019
0.92.0-previ... 12 10/14/2019
0.92.0-previ... 12 10/14/2019
0.91.7-previ... 12 10/11/2019
0.91.6 175 10/11/2019
0.91.6-previ... 13 10/10/2019
0.91.6-previ... 12 10/10/2019
0.91.6-previ... 12 10/10/2019
0.89.7-previ... 13 10/10/2019
Show less