PsMermaidTools

PowerShell Module to create Mermaid diagrams.

Installation

From PowerShell Gallery

Install PsMermaidTools from PowerShell Gallery using a PowerShell command line:

Install-Module -Name PsMermaidTools -Scope CurrentUser

From Source

Invoke-Build Install

Usage

See the command reference for descriptions and examples.

Changelog

See the changelog file.

Development

• This is a Portable Module.
• VSCode is recommended as IDE. VSCode Tasks are configured.
• Build automation is based on InvokeBuild
• Test automation is based on Pester
• Commands are named based on Approved Verbs for PowerShell Commands
• This project uses git-flow.
• This project uses keep a changelog.
• This project uses PsBuildTasks.

Build

The build scripts require InvokeBuild. If it is not installed, install it with the command Install-Module InvokeBuild -Scope CurrentUser.

You can build the module using the VS Code build task or with the command Invoke-Build Build.

Release

1. Create a release branch using git-flow.
2. Update the version number in the module manifest.
3. Extend the changelog in CHANGELOG.md.
4. If you want to create a pre-release:
   1. Push the release branch to github, to publish the pre-release to PsGallery.
5. run Update-Changelog -ReleaseVersion $version -LinkMode None
6. Finish release using git-flow.
7. Check if tags are not pushed to github.
8. Check if the release branch is deleted on github.
9. Create the release on github.