Module description..., different from the one used in the module manifest. (That one goes in the github project description field).
Who this module is aimed at...
/ / / Delete any unnecessary ones fully, otherwise a line break will appear.
Turn the badge into a link by surrounding it in [] brackets, and then adding a (..) link afterwards which points to the azure dev ci pipeline page.
Turn the badge into a link by surrounding it in [] brackets, and then adding a (...) link afterwards which points to the azure dev ci pipeline page.
In order to get started with the latest version, simply download the module from the PSGallery, or install it from powershell by running:
Install-Module <ModuleName>Installing this module does not mean that it is loaded automatically on start-up. Powershell supports loading modules on-the-fly since v3, however the first time you run a command it can be a bit slow to tab-complete parameters or values. If you would like to load this module on shell start-up, add the following line to ~\Documents\Powershell\Profile.ps1:
Import-Module <ModuleName>This module requires minimum Powershell 6.
[This module works on Windows only.]
|
[This module works on Windows, MacOS, and Linux.]
⚠Whilst there are no platform-specific features in use, this module has not yet been tested on either macOS or Linux so there are no guarantees it will work 100% of the time.
Usage instructions/overview of commands taken from the about file.
...
[⚠This module has a complex feature-set. Please read the help pages.]
For a detailed rundown and explanation of all the features in this module, view the help page by running:
Get-Help about_<MODULENAME>For detailed help about a specific command, run:
Get-Help <COMMAND NAME> -FullThe cmdlets in this module have default aliases:
| Cmdlet | Alias |
|---|---|
| New- | n.. |
| Get- | g.. |
| Set- | s.. |
| Remove- | r.. |
The ...[/...s] parameter supports tab-completion of valid existing [or ] names in the following cmdlets:
............
When creating a new , you can pass in a scriptblock which will evaluate...
[For details, see about_<MODULENAME>_scriptblocks.]
|
[For details, see the ... section in the help at: about_<MODULENAME>.]
The following cmdlets support -WhatIf and -Confirm parameters:
.........
Use -WhatIf to see and list what changes a cmdlet will do.
Use -Confirm to ask for a prompt for every state-altering change.
The [<OBJECT>] [and [<OBJECT>]] object[s] within this module has custom formatting rules for all views. Simply pipe the output of the Get-<OBJECT> cmdlet to one of:
| Cmdlet | Alias |
|---|---|
| Format-List | fl |
| Format-Table | ft |
| Format-Custom | fc |
| Format-Wide | fw |
The Format-Custom & Format-List views contain the largest amount of information regarding the .
⚠This module supports Fancy formatting (using colours and emoijs) for enhanced readability. This only works within the Windows Terminal at the moment (I've not tested this on other terminal emulators, but if you know that they support these extra features then let me know). The example below shows the enhanced formatting.
Install the following:
- Powershell Core 7.0.0+
- Pester 4.10.1
- PSScriptAnalyzer 1.18.0+
git clone https://github.com/KubaP/Powershell-<MODULENAME>.git
Navigate to the root repository folder and run the following commands:
& .\build\vsts-prerequisites.ps1
& .\build\vsts-validate.ps1
& .\build\vsts-build-prerequisites
& .\build\vsts-build.ps1 -WorkingDirectory .\ -SkipPublishThe built module will be located in the .\publish folder.
⚠If you need help regarding the usage of the module, please see the help page by running Get-Help about_<MODULENAME>.
If there is a bug/issue, please file it on the github issue tracker.
If you have a suggestion, create a new Github Issue detailing the idea.
Feel free to make pull requests if you have an improvement. Only submit a single feature at a time, and make sure that the code is cleanly formatted, readable, and well commented.
This project is licensed under the GPLv3 license - see LICENSE.md file for details.
Any acknowledgements...?