Sampler

0.115.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.115.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.115.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

gaelcolas

Copyright

Package Details

Author(s)

Gael Colas

Functions

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

Dependencies

- Plaster

Release Notes

## [0.115.0-preview0003] - 2022-05-23

### Added

- Supports using a private Nuget repository, e.g. a _Azure DevOps Server_
_Pipelines_ feed that is using Windows integrated security, or a feed with
no security.
- Now supports getting module version from `dotnet-gitversion` if it is available.
- Tests now run in Pester 5.

### Changed

- The QA test that verifies that a change log entry has been added to CHANGELOG.md
will no longer fail if the CHANGELOG.md has not been committed but is staged
or unstaged. This makes it possible to get the QA tests to pass without having
to first commit changes.

### Fixed

- Task `package_module_nupkg` now correctly adds the release notes to the
Nuget package. Fixes [#373](https://github.com/gaelcolas/Sampler/issues/373)
- Task `publish_module_to_gallery` now correctly adds the release notes to
the published module. Fixes [#373](https://github.com/gaelcolas/Sampler/issues/373)
- Fix a evaluation in the script `Set-SamplerTaskVariable` so it can be tested
individually outside of the pipeline (using `Invoke-Pester`).
- Fix all source files to UTF8 to comply with the HQRM tests (_due to a bug_
_in the HQRM tests that runs in Pester 4 this has not been detected until_
_moving to Pester 5_).
- Remove HQRM rule suppression in source file for `New-SamplerJaCoCoDocument`
since it no longer required.
- Fixed QA test that was breaking release.

FileList

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

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,874	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...	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... (current version)	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