Readme.md

PsSqlMermaid

Module to generate Mermaid ER diagrams for SQL Server databases.

Installation

This module can be installed from PsGallery.

Install-Module -Name PsSqlMermaid -Scope CurrentUser

Alternatively it can be build and installed from source:

1. Install the development dependencies
2. Download or clone it from GitHub
3. Run the installation task:

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.

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 this readme.
4. If you want to create a pre-release.
   1. Push the release branch to github, to publish the pre-release to PsGallery.
5. Finish release using git-flow.
6. Check if tags are not pushed to github.
7. Check if the release branch is deleted on github.
8. Create the release on github.