Sampler

0.119.0-preview0004

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.119.0-preview0004 -AllowPrerelease

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

Install-PSResource -Name Sampler -Version 0.119.0-preview0004 -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

gaelcolas

Copyright

Package Details

Author(s)

Gael Colas

Functions

Add-Sample Convert-SamplerHashtableToString Get-BuiltModuleVersion Get-ClassBasedResourceName Get-CodeCoverageThreshold Get-MofSchemaName Get-OperatingSystemShortName Get-PesterOutputFileFileName Get-Psm1SchemaName Get-SamplerAbsolutePath Get-SamplerBuildVersion 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

- Plaster

Release Notes

## [0.119.0-preview0004] - 2025-09-05

### Added
- Note for cahning DestinationPath to the location where the module should be created depending on you platform and workflow.
- HomeBrew installation instructions for GitVersion

### Fixed

- Add retry logic for ModuleFast dependency installation ([#510](https://github.com/gaelcolas/Sampler/issues/510)).
- Using full-qualified call for `Expand-Archive` ([#519](https://github.com/gaelcolas/Sampler/issues/519)).
- Fixed a variable scoping issue preventing Pester tests to be invoked after the
first build ([#523](https://github.com/gaelcolas/Sampler/issues/523)).
- Fixed another variable scoping issue preventing Pester tests to be invoked
after the first build ([#527](https://github.com/gaelcolas/Sampler/issues/527)).
- Fixed typo in build.ps1 and added missing descriptions to parameters.
- Fixed links to Build Tasks Variables documentation.
- `dsccommunity` Template
- Added DocGenerator tasks and configuration to `build.yaml` [#468](https://github.com/gaelcolas/Sampler/issues/468).
- Updated HQRM task to use Pester 5 version.
- Fix QA tests failing with latest version of DscResource.Test.

### Changed

- The use of Write-* cmdlets has been standardized to a consistent style
with named parameters (-Message and -Object).

FileList

Sampler.nuspec
Templates\Git\gitattributes
Sampler.psd1
Templates\VscodeConfig\settings.json
Templates\VscodeConfig\plasterManifest.xml
Sampler.psm1
Templates\VscodeConfig\extensions.json
scripts\Set-SamplerTaskVariable.ps1
Templates\VscodeConfig\analyzersettings.psd1
tasks\DeployAll.PSDeploy.build.ps1
Templates\VscodeConfig\tasks.json
tasks\DscResource.Test.build.ps1
Templates\MofResource\plasterManifest.xml
tasks\Clean.ModuleBuilder.build.ps1
Templates\ChocolateyPipeline\plasterManifest.xml
tasks\Create_Changelog_Branch.build.ps1
Templates\ChocolateyPipeline\chocobuild.yml.template
tasks\JaCoCo.coverage.build.ps1
Templates\PrivateFunction\Get-PrivateFunction.ps1.template
tasks\SetPsModulePath.build.ps1
Templates\PrivateFunction\Get-PrivateFunction.tests.ps1.template
tasks\ChocolateyPackage.build.ps1
Templates\PrivateFunction\plasterManifest.xml
tasks\Create_Release_Git_Tag.build.ps1
Templates\Composite\plasterManifest.xml
tasks\Build-Module.ModuleBuilder.build.ps1
Templates\Composite\Composite.schema.psm1.template
tasks\GuestConfig.build.ps1
Templates\GithubConfig\PULL_REQUEST_TEMPLATE.md
tasks\release.module.build.ps1
Templates\GithubConfig\PULL_REQUEST_TEMPLATE_dsccommunity.md
tasks\Invoke-Pester.pester.build.ps1
Templates\GithubConfig\plasterManifest.xml
tasks\generateHelp.PlatyPS.build.ps1
Templates\PublicFunction\plasterManifest.xml
en-US\about_Sampler.help.txt
Templates\PublicFunction\Get-Something.tests.ps1.template
en-US\Sampler.strings.psd1
Templates\PublicFunction\Get-Something.ps1.template
en-US\Sampler-help.xml
Templates\Classes\Classes\2.class2.ps1
Templates\Classes\plasterManifest.xml
Templates\Classes\Classes\4.class12.ps1
Templates\ClassResource\Reason.ps1.template
Templates\Classes\Classes\3.class11.ps1
Templates\ClassResource\plasterManifest.xml
Templates\Classes\Classes\1.class1.ps1
Templates\ClassResource\DSC_ClassResource.ps1.template
Templates\ClassResource\Private\Set-HelpFunctionProperty.ps1
Templates\ClassResource\1.Ensure.ps1.template
Templates\ClassResource\Private\ConvertTo-HashtableFromObject.ps1
Templates\PublicCallPrivateFunctions\plasterManifest.xml
Templates\ClassResource\Private\Get-DummyObject.ps1
Templates\ChocolateyPackage\plasterManifest.xml
Templates\ClassResource\en-US\DSC_ClassResource.strings.psd1.template
Templates\Examples\README.md
Templates\ChocolateyPackage\myPackage\README.md
Templates\Enum\Enum.ps1.template
Templates\ChocolateyPackage\myPackage\_TODO.txt
Templates\Enum\plasterManifest.xml
Templates\ChocolateyPackage\myPackage\mypackage.nuspec.template
Templates\ClassFolderResource\Reason.ps1.template
Templates\ClassFolderResource\Private\ConvertTo-HashtableFromObject.ps1
Templates\ClassFolderResource\DSC_ClassFolder.ps1
Templates\ClassFolderResource\Private\Set-FileAttribute.ps1
Templates\ClassFolderResource\plasterManifest.xml
Templates\ClassFolderResource\Private\Test-FileAttribute.ps1
Templates\ClassFolderResource\1.Ensure.ps1.template
Templates\ClassFolderResource\en-US\DSC_ClassFolder.strings.psd1
Templates\HelperSubModules\plasterManifest.xml
Templates\Sampler\LICENSES\LICENSE.Apache.template
Templates\GCPackage\plasterManifest.xml
Templates\Sampler\LICENSES\LICENSE.MIT.template
Templates\Sampler\README.md
Templates\MofResource\DSC_Folder\DSC_Folder.psm1
Templates\Sampler\Get-PrivateFunction.tests.ps1.template
Templates\MofResource\DSC_Folder\DSC_Folder.schema.mof
Templates\Sampler\Get-Something.ps1
Templates\GithubConfig\ISSUE_TEMPLATE\config.yml.template
Templates\Sampler\azure-pipelines.yml.template
Templates\GithubConfig\ISSUE_TEMPLATE\Problem_with_module.yml.template
Templates\Sampler\CONTRIBUTING.md
Templates\GithubConfig\ISSUE_TEMPLATE\Problem_with_resource.yml.template
Templates\Sampler\README.md.template
Templates\GithubConfig\ISSUE_TEMPLATE\Resource_proposal.yml
Templates\Sampler\codecov.yml.template
Templates\GithubConfig\ISSUE_TEMPLATE\General.md
Templates\Sampler\appveyor.yml
Templates\ChocolateyPackage\myPackage\tools\chocolateyinstall.ps1
Templates\Sampler\CHANGELOG.md.template
Templates\ChocolateyPackage\myPackage\tools\chocolateyuninstall.ps1
Templates\Sampler\module.template
Templates\ChocolateyPackage\myPackage\tools\VERIFICATION.txt
Templates\Sampler\markdownlint.json
Templates\ChocolateyPackage\myPackage\tools\chocolateybeforemodify.ps1
Templates\Sampler\azure-pipelines_dsccommunity.yml.template
Templates\ChocolateyPackage\myPackage\tools\LICENSE.txt
Templates\Sampler\about_ModuleName.help.template
Templates\Examples\Resources\Folder\1-DscResourceTemplate_CreateFolderAsSystemConfig.ps1
Templates\Sampler\plasterManifest.xml
Templates\Examples\Resources\Folder\2-DscResourceTemplate_CreateFolderAsUserConfig.ps1
Templates\Sampler\Get-PrivateFunction.ps1
Templates\Examples\Resources\Folder\3-DscResourceTemplate_RemoveFolderConfig.ps1
Templates\Sampler\kitchen.yml.template
Templates\HelperSubModules\Modules\HelperSubmodule\HelperSubmodule.psm1
Templates\Sampler\module.tests.ps1.template
Templates\GCPackage\GCPackages\MyGuestConfigPackage\MyGuestConfigPackage.config.ps1.template
Templates\Sampler\Get-Something.tests.ps1.template
Templates\MofResource\DSC_Folder\en-US\DSC_Folder.strings.psd1
Templates\Sampler\README_dsccommunity.md.template
Templates\MofResource\Modules\Folder.Common\Folder.Common.psm1
Templates\Sampler\CODE_OF_CONDUCT.md
Templates\Classes\tests\Unit\Classes\class2.tests.ps1
Templates\Build\SECURITY.dsccommunity.md
Templates\Classes\tests\Unit\Classes\class12.tests.ps1
Templates\Build\CONTRIBUTING.md
Templates\Classes\tests\Unit\Classes\class1.tests.ps1
Templates\Build\README.md.template
Templates\Classes\tests\Unit\Classes\class11.tests.ps1
Templates\Build\CHANGELOG.md.template
Templates\ClassResource\tests\Unit\ClassResource\DSC_ClassResource.tests.ps1.template
Templates\Build\SECURITY.generic.md
Templates\ClassResource\tests\Unit\Private\ConvertTo-HashtableFromObject.tests.ps1.template
Templates\Build\plasterManifest.xml
Templates\ChocolateyPackage\tests\ChocolateyPackage\myPackage\myPackage.PesterV4.tests.ps1
Templates\Build\Resolve-Dependency.ps1
Templates\ChocolateyPackage\tests\ChocolateyPackage\myPackage\myPackage.PesterV5.tests.ps1
Templates\Build\build.yaml.template
Templates\ClassFolderResource\tests\Unit\ClassResource\DSC_ClassFolder.tests.ps1
Templates\Build\CODE_OF_CONDUCT.md
Templates\ClassFolderResource\tests\Unit\Private\ConvertTo-HashtableFromObject.tests.ps1
Templates\Build\build.ps1
Templates\ClassFolderResource\tests\Unit\Private\Test-FileAttribute.tests.ps1
Templates\Build\RequiredModules.psd1.template
Templates\ClassFolderResource\tests\Unit\Private\Set-FileAttribute.tests.ps1
Templates\Build\Resolve-Dependency.psd1.template
Templates\MofResource\tests\Unit\DSCResources\DSC_Folder.tests.ps1.template
Templates\Git\GitVersion.yml.template
Templates\MofResource\tests\Unit\Modules\Folder.Common.tests.ps1
Templates\Git\gitignore

Version History

Version	Downloads	Last updated
0.119.0-prev...	19	9/6/2025
0.119.0-prev... (current version)	16	9/5/2025
0.119.0-prev...	43	9/2/2025
0.119.0-prev...	581	7/16/2025
0.119.0-prev...	32	7/15/2025
0.118.4-prev...	339	6/11/2025
0.118.4-prev...	144	5/20/2025
0.118.4-prev...	38	5/14/2025
0.118.3	51,887	4/29/2025
0.118.3-prev...	5	4/29/2025
0.118.3-prev...	425	2/28/2025
0.118.2	42,674	1/19/2025
0.118.2-prev...	5	1/18/2025
0.118.2-prev...	6	1/18/2025
0.118.2-prev...	1,435	8/26/2024
0.118.2-prev...	1,216	7/28/2024
0.118.2-prev...	215	7/24/2024
0.118.1	90,702	7/20/2024
0.118.1-prev...	9	7/18/2024
0.118.1-prev...	7	7/17/2024
0.118.0-prev...	3,698	4/17/2024
0.118.0-prev...	376	4/6/2024
0.118.0-prev...	1,189	2/9/2024
0.118.0-prev...	1,080	1/13/2024
0.118.0-prev...	296	1/7/2024
0.117.1-prev...	7	1/7/2024
0.117.1-prev...	505	12/24/2023
0.117.0	171,035	9/29/2023
0.117.0-prev...	195	9/24/2023
0.117.0-prev...	28	9/21/2023
0.117.0-prev...	1,634	7/1/2023
0.116.6-prev...	7	6/30/2023
0.116.5	84,209	4/19/2023
0.116.5-prev...	167	4/17/2023
0.116.4	3,245	4/6/2023
0.116.4-prev...	8	4/6/2023
0.116.3	1,607	4/1/2023
0.116.3-prev...	7	4/1/2023
0.116.3-prev...	640	3/7/2023
0.116.2	10,802	3/1/2023
0.116.2-prev...	10	3/1/2023
0.116.2-prev...	1,051	1/24/2023
0.116.1	11,938	1/9/2023
0.116.0	26,852	11/8/2022
0.116.0-prev...	16	11/8/2022
0.116.0-prev...	37	11/1/2022
0.116.0-prev...	12	11/1/2022
0.116.0-prev...	12	11/1/2022
0.116.0-prev...	12	11/1/2022
0.116.0-prev...	792	8/3/2022
0.116.0-prev...	14	8/1/2022
0.116.0-prev...	754	7/9/2022
0.115.0	4,715	6/9/2022
0.115.0-prev...	457	5/29/2022
0.115.0-prev...	12	5/28/2022
0.115.0-prev...	133	5/23/2022
0.115.0-prev...	54	5/21/2022
0.115.0-prev...	52	5/20/2022
0.114.1-prev...	24	5/20/2022
0.114.0	1,473	5/13/2022
0.113.0-prev...	13	5/13/2022
0.112.4-prev...	29	5/13/2022
0.112.4-prev...	22	5/13/2022
0.112.3	1,772	3/31/2022
0.112.3-prev...	12	3/31/2022
0.112.2	545	3/20/2022
0.112.2-prev...	13	3/20/2022
0.112.2-prev...	830	2/16/2022
0.112.2-prev...	274	1/26/2022
0.112.1	2,408	1/23/2022
0.112.1-prev...	12	1/23/2022
0.112.1-prev...	12	1/23/2022
0.112.1-prev...	12	1/23/2022
0.112.1-prev...	311	12/1/2021
0.112.1-prev...	144	11/15/2021
0.112.1-prev...	165	10/1/2021
0.112.0	4,293	9/23/2021
0.112.0-prev...	22	9/8/2021
0.112.0-prev...	12	9/8/2021
0.112.0-prev...	15	9/5/2021
0.112.0-prev...	51	8/18/2021
0.111.8	1,314	8/8/2021
0.111.8-prev...	17	8/7/2021
0.111.7	238	7/31/2021
0.111.7-prev...	60	7/30/2021
0.111.7-prev...	75	7/28/2021
0.111.6	680	7/3/2021
0.111.6-prev...	24	7/2/2021
0.111.6-prev...	14	7/1/2021
0.111.5	272	6/25/2021
0.111.5-prev...	13	6/25/2021
0.111.5-prev...	98	6/17/2021
0.111.4	495	6/3/2021
0.111.4-prev...	12	6/3/2021
0.111.3	539	5/21/2021
0.111.3-prev...	12	5/21/2021
0.111.2	32	5/21/2021
0.111.2-prev...	12	5/21/2021
0.111.1	379	5/15/2021
0.111.1-prev...	13	5/15/2021
0.111.1-prev...	13	5/15/2021
0.111.0	198	5/13/2021
0.111.0-prev...	15	5/13/2021
0.111.0-prev...	14	5/13/2021
0.111.0-prev...	14	5/13/2021
0.111.0-prev...	71	5/7/2021
0.111.0-prev...	13	5/6/2021
0.111.0-prev...	22	5/4/2021
0.111.0-prev...	69	4/20/2021
0.111.0-prev...	65	4/16/2021
0.110.2-prev...	27	4/14/2021
0.110.2-prev...	58	4/13/2021
0.110.1	1,004	4/8/2021
0.110.1-prev...	16	4/8/2021
0.110.0	23	4/8/2021
0.110.0-prev...	14	4/8/2021
0.110.0-prev...	14	4/7/2021
0.110.0-prev...	14	4/7/2021
0.110.0-prev...	14	4/7/2021
0.109.11-pre...	21	3/29/2021
0.109.10	670	3/24/2021
0.109.10-pre...	18	3/22/2021
0.109.9	260	3/20/2021
0.109.9-prev...	14	3/20/2021
0.109.8	28	3/20/2021
0.109.8-prev...	15	3/20/2021
0.109.7	21	3/20/2021
0.109.7-prev...	15	3/20/2021
0.109.6	228	3/18/2021
0.109.6-prev...	18	3/18/2021
0.109.6-prev...	22	3/16/2021
0.109.5	380	3/10/2021
0.109.5-prev...	20	3/10/2021
0.109.5-prev...	23	3/10/2021
0.109.5-prev...	43	3/8/2021
0.109.5-prev...	15	3/7/2021
0.109.4	484	3/6/2021
0.109.4-prev...	16	3/6/2021
0.109.3	880	2/16/2021
0.109.3-prev...	16	2/16/2021
0.109.2	860	1/13/2021
0.109.2-prev...	17	1/13/2021
0.109.2-prev...	16	1/13/2021
0.109.1	324	1/6/2021
0.109.1-prev...	16	1/4/2021
0.109.1-prev...	16	12/29/2020
0.109.0	1,119	11/24/2020
0.109.0-prev...	15	11/24/2020
0.109.0-prev...	22	11/19/2020
0.109.0-prev...	16	11/18/2020
0.109.0-prev...	15	10/13/2020
0.108.0	710	9/14/2020
0.108.0-prev...	14	9/13/2020
0.108.0-prev...	13	9/13/2020
0.107.4-prev...	13	9/12/2020
0.107.4-prev...	13	9/11/2020
0.107.3	214	9/10/2020
0.107.3-prev...	13	9/10/2020
0.107.2	209	9/8/2020
0.107.2-prev...	14	9/8/2020
0.107.1	179	9/8/2020
0.107.1-prev...	14	9/7/2020
0.107.0	171	9/7/2020
0.107.0-prev...	13	9/7/2020
0.107.0-prev...	14	9/7/2020
0.106.1	209	8/30/2020
0.106.1-prev...	14	8/30/2020
0.106.0	190	8/30/2020
0.106.0-prev...	14	8/29/2020
0.106.0-prev...	22	8/21/2020
0.106.0-prev...	35	8/19/2020
0.106.0-prev...	15	8/18/2020
0.106.0-prev...	16	8/8/2020
0.105.7-prev...	19	7/11/2020
0.105.6	1,898	6/1/2020
0.105.6-prev...	14	6/1/2020
0.105.5	279	5/29/2020
0.105.5-prev...	15	5/29/2020
0.105.5-prev...	14	5/29/2020
0.105.4	174	5/29/2020
0.105.4-prev...	14	5/29/2020
0.105.4-prev...	14	5/28/2020
0.105.3	861	5/9/2020
0.105.3-prev...	14	5/9/2020
0.105.2	658	5/1/2020
0.105.2-prev...	14	5/1/2020
0.105.2-prev...	14	5/1/2020
0.105.2-prev...	14	4/24/2020
0.105.2-prev...	14	4/24/2020
0.105.1	480	4/24/2020
0.105.1-prev...	14	4/24/2020
0.105.0	301	4/21/2020
0.105.0-prev...	14	4/21/2020
0.105.0-prev...	14	4/18/2020
0.104.0	3,965	4/18/2020
0.104.0-prev...	14	4/18/2020
0.104.0-prev...	14	4/17/2020
0.103.0	209	4/17/2020
0.103.0-prev...	14	4/17/2020
0.102.1	1,335	2/21/2020
0.102.1-prev...	17	2/18/2020
0.102.1-prev...	16	2/18/2020
0.102.0	274	2/14/2020
0.102.0-prev...	17	2/14/2020
0.102.0-prev...	17	2/12/2020
0.101.0	252	2/10/2020
0.101.0-prev...	16	2/10/2020
0.101.0-prev...	16	2/7/2020
0.101.0-prev...	16	2/7/2020
0.100.0	455	2/1/2020
0.100.0-prev...	16	2/1/2020
0.99.4	390	1/22/2020
0.99.4-previ...	17	1/22/2020
0.99.4-previ...	16	1/22/2020
0.99.4-previ...	15	1/22/2020
0.99.3	182	1/21/2020
0.99.3-previ...	15	1/21/2020
0.99.2	299	1/16/2020
0.99.2-previ...	16	1/16/2020
0.99.1	154	1/16/2020
0.99.1-previ...	15	1/16/2020
0.99.1-previ...	17	1/9/2020
0.99.1-previ...	15	1/7/2020
0.99.1-previ...	15	1/7/2020
0.99.0	684	1/1/2020
0.99.0-previ...	14	1/1/2020
0.99.0-previ...	15	1/1/2020
0.99.0-previ...	15	1/1/2020
0.99.0-previ...	19	12/28/2019
0.99.0-previ...	16	12/28/2019
0.99.0-previ...	15	12/26/2019
0.98.1	515	12/24/2019
0.98.1-previ...	16	12/24/2019
0.98.1-previ...	15	12/23/2019
0.98.0	192	12/22/2019
0.98.0-previ...	16	12/22/2019
0.98.0-previ...	16	12/21/2019
0.97.0	450	12/9/2019
0.97.0-previ...	15	12/9/2019
0.96.1-previ...	16	11/8/2019
0.96.1-previ...	15	11/5/2019
0.96.0	340	11/1/2019
0.96.0-previ...	16	11/1/2019
0.95.2-previ...	16	11/1/2019
0.95.1	191	11/1/2019
0.95.1-previ...	15	11/1/2019
0.95.1-previ...	15	11/1/2019
0.95.0	177	11/1/2019
0.95.0-previ...	15	11/1/2019
0.94.0	180	10/30/2019
0.94.0-previ...	16	10/30/2019
0.94.0-previ...	16	10/30/2019
0.93.3-previ...	15	10/30/2019
0.93.2	176	10/30/2019
0.93.2-previ...	15	10/30/2019
0.93.2-previ...	15	10/30/2019
0.93.2-previ...	14	10/29/2019
0.93.1	183	10/29/2019
0.93.1-previ...	16	10/29/2019
0.93.1-previ...	15	10/29/2019
0.93.0	175	10/29/2019
0.93.0-previ...	15	10/29/2019
0.93.0-previ...	15	10/29/2019
0.93.0-previ...	14	10/23/2019
0.93.0-previ...	14	10/23/2019
0.93.0-previ...	22	10/22/2019
0.93.0-previ...	17	10/20/2019
0.92.2-previ...	15	10/15/2019
0.92.1	203	10/15/2019
0.92.1-previ...	14	10/15/2019
0.92.0	174	10/15/2019
0.92.0-previ...	14	10/14/2019
0.92.0-previ...	15	10/14/2019
0.92.0-previ...	14	10/14/2019
0.92.0-previ...	14	10/14/2019
0.91.7-previ...	14	10/11/2019
0.91.6	177	10/11/2019
0.91.6-previ...	15	10/10/2019
0.91.6-previ...	14	10/10/2019
0.91.6-previ...	14	10/10/2019
0.89.7-previ...	15	10/10/2019