Sampler

0.116.3-preview0001

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.116.3-preview0001 -AllowPrerelease

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

Install-PSResource -Name Sampler -Version 0.116.3-preview0001 -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.116.3-preview0001] - 2023-03-07

### Changed

- Template `SimpleModule`
 - The template has been changed to create a module with the minimum scaffolding
   when using default values for the template questions. The minimum scaffolding
   enable the building and testing of the module, but default there is no pipeline
   so it possible to use any platform to run the pipeline.
 - Additional template parameters have been added which will add additional
   functionality to the module.
   - `UseGit` - This parameter enables project files that helps with the use
     of Git for the project. The template will ask if Git should be used, default
     is No.
   - `UseGitVersion` - This parameter adds project files that helps with
     the use of GitVersion for the project. GitVersion is dependent on Git
     being used for the project. The template will ask if GitVersion should
     be used if the use of Git was chosen, default is No.
   - `UseCodeCovIo` - This parameter adds project files that helps with
     the use of CodeCov.io for the project. CodeCov.io is dependent on Git
     being used for the project. The template will ask if CodeCov.io should
     be used if the use of Git was chosen, default is No.
   - `UseGitHub` - This parameter adds project files that helps with
     the use of GitHb.com for the project. GitHub.com is dependent on Git
     being used for the project. The template will ask if GitHub.com should
     be used if the use of Git was chosen, default is No.
   - `UseAzurePipelines` - This parameter adds project files that enables
     the project to run the pipeline in Azure Pipelines (in Azure DevOps).
     The template will ask if Azure Pipelines should be used, default is No.
   - `UseVSCode` - This parameter adds project files that helps when using
     Visual Studio Code as the project code editor. The template will ask
     if  Visual Studio Code should be used, default is No.
 - The file `build.yaml` will only contain tasks from `Sampler.GitHubTasks`
   if template parameter `UseGitHub` is set to true (the answer to the
   template question is Yes).
 - The file `RequiredModules.psd1` will only contain the module `Sampler.GitHubTasks`
   if template parameter `UseGitHub` is set to true (the answer to the
   template question is Yes).
 - If Git is not used (`UseGit` is false) the QA test that uses Git is
   removed for the generated file `module.tests.ps1`.
- Removed module Plaster from the template file `RequiredModules.psd1.template`
 since it is not direct requirement for any project. _It will still be saved_
 _to `output/RequiredModules` for a project as it is defined as a required_
 _module in Sampler's module manifest, and Sampler is still a required modul._

### Fixed

- Removed duplicate header in template file `README.md.template`.
- Fix typo in the file `about_ModuleName.help.template` and in `module.template`.
- Integration tests clean up the test drive after each test.
- Update generated module manifest to have recommended values for properties.
 Fixes [#326](https://github.com/gaelcolas/Sampler/issues/326).
- Now correctly uses the key `CodeCoverage` in the file `build.yaml.template`.
 Fixes [#359](https://github.com/gaelcolas/Sampler/issues/359).

FileList

Version History

Version Downloads Last updated
0.118.0-prev... 335 4/6/2024
0.118.0-prev... 1,174 2/9/2024
0.118.0-prev... 1,077 1/13/2024
0.118.0-prev... 293 1/7/2024
0.117.1-prev... 4 1/7/2024
0.117.1-prev... 502 12/24/2023
0.117.0 114,320 9/29/2023
0.117.0-prev... 192 9/24/2023
0.117.0-prev... 25 9/21/2023
0.117.0-prev... 1,632 7/1/2023
0.116.6-prev... 4 6/30/2023
0.116.5 84,203 4/19/2023
0.116.5-prev... 164 4/17/2023
0.116.4 3,242 4/6/2023
0.116.4-prev... 5 4/6/2023
0.116.3 1,605 4/1/2023
0.116.3-prev... 4 4/1/2023
0.116.3-prev... (current version) 638 3/7/2023
0.116.2 10,248 3/1/2023
0.116.2-prev... 7 3/1/2023
0.116.2-prev... 1,048 1/24/2023
0.116.1 11,932 1/9/2023
0.116.0 26,847 11/8/2022
0.116.0-prev... 13 11/8/2022
0.116.0-prev... 34 11/1/2022
0.116.0-prev... 9 11/1/2022
0.116.0-prev... 10 11/1/2022
0.116.0-prev... 9 11/1/2022
0.116.0-prev... 789 8/3/2022
0.116.0-prev... 11 8/1/2022
0.116.0-prev... 751 7/9/2022
0.115.0 4,706 6/9/2022
0.115.0-prev... 454 5/29/2022
0.115.0-prev... 9 5/28/2022
0.115.0-prev... 130 5/23/2022
0.115.0-prev... 51 5/21/2022
0.115.0-prev... 49 5/20/2022
0.114.1-prev... 21 5/20/2022
0.114.0 1,469 5/13/2022
0.113.0-prev... 10 5/13/2022
0.112.4-prev... 26 5/13/2022
0.112.4-prev... 19 5/13/2022
0.112.3 1,769 3/31/2022
0.112.3-prev... 9 3/31/2022
0.112.2 528 3/20/2022
0.112.2-prev... 10 3/20/2022
0.112.2-prev... 827 2/16/2022
0.112.2-prev... 271 1/26/2022
0.112.1 2,405 1/23/2022
0.112.1-prev... 9 1/23/2022
0.112.1-prev... 9 1/23/2022
0.112.1-prev... 9 1/23/2022
0.112.1-prev... 308 12/1/2021
0.112.1-prev... 141 11/15/2021
0.112.1-prev... 162 10/1/2021
0.112.0 4,290 9/23/2021
0.112.0-prev... 19 9/8/2021
0.112.0-prev... 9 9/8/2021
0.112.0-prev... 12 9/5/2021
0.112.0-prev... 48 8/18/2021
0.111.8 1,311 8/8/2021
0.111.8-prev... 14 8/7/2021
0.111.7 235 7/31/2021
0.111.7-prev... 57 7/30/2021
0.111.7-prev... 72 7/28/2021
0.111.6 677 7/3/2021
0.111.6-prev... 21 7/2/2021
0.111.6-prev... 11 7/1/2021
0.111.5 269 6/25/2021
0.111.5-prev... 10 6/25/2021
0.111.5-prev... 95 6/17/2021
0.111.4 492 6/3/2021
0.111.4-prev... 9 6/3/2021
0.111.3 536 5/21/2021
0.111.3-prev... 9 5/21/2021
0.111.2 29 5/21/2021
0.111.2-prev... 9 5/21/2021
0.111.1 377 5/15/2021
0.111.1-prev... 10 5/15/2021
0.111.1-prev... 10 5/15/2021
0.111.0 195 5/13/2021
0.111.0-prev... 12 5/13/2021
0.111.0-prev... 11 5/13/2021
0.111.0-prev... 11 5/13/2021
0.111.0-prev... 68 5/7/2021
0.111.0-prev... 10 5/6/2021
0.111.0-prev... 19 5/4/2021
0.111.0-prev... 66 4/20/2021
0.111.0-prev... 62 4/16/2021
0.110.2-prev... 24 4/14/2021
0.110.2-prev... 54 4/13/2021
0.110.1 1,000 4/8/2021
0.110.1-prev... 12 4/8/2021
0.110.0 19 4/8/2021
0.110.0-prev... 10 4/8/2021
0.110.0-prev... 10 4/7/2021
0.110.0-prev... 10 4/7/2021
0.110.0-prev... 10 4/7/2021
0.109.11-pre... 18 3/29/2021
0.109.10 666 3/24/2021
0.109.10-pre... 14 3/22/2021
0.109.9 256 3/20/2021
0.109.9-prev... 10 3/20/2021
0.109.8 24 3/20/2021
0.109.8-prev... 11 3/20/2021
0.109.7 17 3/20/2021
0.109.7-prev... 11 3/20/2021
0.109.6 224 3/18/2021
0.109.6-prev... 14 3/18/2021
0.109.6-prev... 18 3/16/2021
0.109.5 376 3/10/2021
0.109.5-prev... 17 3/10/2021
0.109.5-prev... 19 3/10/2021
0.109.5-prev... 39 3/8/2021
0.109.5-prev... 11 3/7/2021
0.109.4 481 3/6/2021
0.109.4-prev... 12 3/6/2021
0.109.3 876 2/16/2021
0.109.3-prev... 12 2/16/2021
0.109.2 856 1/13/2021
0.109.2-prev... 13 1/13/2021
0.109.2-prev... 12 1/13/2021
0.109.1 320 1/6/2021
0.109.1-prev... 12 1/4/2021
0.109.1-prev... 12 12/29/2020
0.109.0 1,115 11/24/2020
0.109.0-prev... 11 11/24/2020
0.109.0-prev... 18 11/19/2020
0.109.0-prev... 12 11/18/2020
0.109.0-prev... 11 10/13/2020
0.108.0 704 9/14/2020
0.108.0-prev... 10 9/13/2020
0.108.0-prev... 9 9/13/2020
0.107.4-prev... 9 9/12/2020
0.107.4-prev... 9 9/11/2020
0.107.3 210 9/10/2020
0.107.3-prev... 9 9/10/2020
0.107.2 205 9/8/2020
0.107.2-prev... 10 9/8/2020
0.107.1 176 9/8/2020
0.107.1-prev... 10 9/7/2020
0.107.0 167 9/7/2020
0.107.0-prev... 9 9/7/2020
0.107.0-prev... 10 9/7/2020
0.106.1 205 8/30/2020
0.106.1-prev... 10 8/30/2020
0.106.0 186 8/30/2020
0.106.0-prev... 10 8/29/2020
0.106.0-prev... 18 8/21/2020
0.106.0-prev... 31 8/19/2020
0.106.0-prev... 11 8/18/2020
0.106.0-prev... 12 8/8/2020
0.105.7-prev... 15 7/11/2020
0.105.6 1,894 6/1/2020
0.105.6-prev... 10 6/1/2020
0.105.5 275 5/29/2020
0.105.5-prev... 11 5/29/2020
0.105.5-prev... 10 5/29/2020
0.105.4 170 5/29/2020
0.105.4-prev... 10 5/29/2020
0.105.4-prev... 10 5/28/2020
0.105.3 857 5/9/2020
0.105.3-prev... 10 5/9/2020
0.105.2 654 5/1/2020
0.105.2-prev... 10 5/1/2020
0.105.2-prev... 10 5/1/2020
0.105.2-prev... 10 4/24/2020
0.105.2-prev... 10 4/24/2020
0.105.1 476 4/24/2020
0.105.1-prev... 10 4/24/2020
0.105.0 297 4/21/2020
0.105.0-prev... 10 4/21/2020
0.105.0-prev... 10 4/18/2020
0.104.0 3,385 4/18/2020
0.104.0-prev... 10 4/18/2020
0.104.0-prev... 10 4/17/2020
0.103.0 205 4/17/2020
0.103.0-prev... 10 4/17/2020
0.102.1 1,331 2/21/2020
0.102.1-prev... 13 2/18/2020
0.102.1-prev... 12 2/18/2020
0.102.0 271 2/14/2020
0.102.0-prev... 13 2/14/2020
0.102.0-prev... 13 2/12/2020
0.101.0 248 2/10/2020
0.101.0-prev... 12 2/10/2020
0.101.0-prev... 12 2/7/2020
0.101.0-prev... 12 2/7/2020
0.100.0 450 2/1/2020
0.100.0-prev... 12 2/1/2020
0.99.4 387 1/22/2020
0.99.4-previ... 14 1/22/2020
0.99.4-previ... 13 1/22/2020
0.99.4-previ... 12 1/22/2020
0.99.3 179 1/21/2020
0.99.3-previ... 12 1/21/2020
0.99.2 296 1/16/2020
0.99.2-previ... 13 1/16/2020
0.99.1 151 1/16/2020
0.99.1-previ... 12 1/16/2020
0.99.1-previ... 14 1/9/2020
0.99.1-previ... 12 1/7/2020
0.99.1-previ... 12 1/7/2020
0.99.0 681 1/1/2020
0.99.0-previ... 12 1/1/2020
0.99.0-previ... 12 1/1/2020
0.99.0-previ... 12 1/1/2020
0.99.0-previ... 16 12/28/2019
0.99.0-previ... 13 12/28/2019
0.99.0-previ... 12 12/26/2019
0.98.1 512 12/24/2019
0.98.1-previ... 13 12/24/2019
0.98.1-previ... 12 12/23/2019
0.98.0 189 12/22/2019
0.98.0-previ... 13 12/22/2019
0.98.0-previ... 13 12/21/2019
0.97.0 447 12/9/2019
0.97.0-previ... 12 12/9/2019
0.96.1-previ... 13 11/8/2019
0.96.1-previ... 12 11/5/2019
0.96.0 337 11/1/2019
0.96.0-previ... 13 11/1/2019
0.95.2-previ... 13 11/1/2019
0.95.1 188 11/1/2019
0.95.1-previ... 12 11/1/2019
0.95.1-previ... 12 11/1/2019
0.95.0 174 11/1/2019
0.95.0-previ... 12 11/1/2019
0.94.0 177 10/30/2019
0.94.0-previ... 13 10/30/2019
0.94.0-previ... 13 10/30/2019
0.93.3-previ... 12 10/30/2019
0.93.2 173 10/30/2019
0.93.2-previ... 12 10/30/2019
0.93.2-previ... 12 10/30/2019
0.93.2-previ... 11 10/29/2019
0.93.1 180 10/29/2019
0.93.1-previ... 13 10/29/2019
0.93.1-previ... 12 10/29/2019
0.93.0 172 10/29/2019
0.93.0-previ... 12 10/29/2019
0.93.0-previ... 12 10/29/2019
0.93.0-previ... 11 10/23/2019
0.93.0-previ... 11 10/23/2019
0.93.0-previ... 19 10/22/2019
0.93.0-previ... 14 10/20/2019
0.92.2-previ... 12 10/15/2019
0.92.1 200 10/15/2019
0.92.1-previ... 11 10/15/2019
0.92.0 171 10/15/2019
0.92.0-previ... 11 10/14/2019
0.92.0-previ... 12 10/14/2019
0.92.0-previ... 11 10/14/2019
0.92.0-previ... 11 10/14/2019
0.91.7-previ... 11 10/11/2019
0.91.6 174 10/11/2019
0.91.6-previ... 12 10/10/2019
0.91.6-previ... 11 10/10/2019
0.91.6-previ... 11 10/10/2019
0.89.7-previ... 12 10/10/2019
Show less