Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/abbgrade/PsMermaidTools
PowerShell Module to create Mermaid diagrams.
https://github.com/abbgrade/PsMermaidTools
c4-model er-diagram mermaid powershell
Last synced: 3 months ago
JSON representation
PowerShell Module to create Mermaid diagrams.
- Host: GitHub
- URL: https://github.com/abbgrade/PsMermaidTools
- Owner: abbgrade
- License: mit
- Created: 2022-09-11T10:14:53.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2024-02-12T14:04:15.000Z (9 months ago)
- Last Synced: 2024-05-18T06:35:06.935Z (6 months ago)
- Topics: c4-model, er-diagram, mermaid, powershell
- Language: PowerShell
- Homepage: https://abbgrade.github.io/PsMermaidTools/
- Size: 103 KB
- Stars: 5
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: Readme.md
- Changelog: CHANGELOG.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
- jimsghstars - abbgrade/PsMermaidTools - PowerShell Module to create Mermaid diagrams. (PowerShell)
README
# PsMermaidTools
PowerShell Module to create [Mermaid](https://mermaid-js.github.io) diagrams.
## Installation
### From PowerShell Gallery
Install PsMermaidTools from [PowerShell Gallery](https://www.powershellgallery.com/packages/PsMermaidTools) using a PowerShell command line:
```powershell
Install-Module -Name PsMermaidTools -Scope CurrentUser
```
### From Source
```powershell
Invoke-Build Install
```
## Usage
See [the command reference](./docs/) for descriptions and examples.
## Changelog
See the [changelog](./CHANGELOG.md) file.
## Development
[](https://github.com/abbgrade/PsMermaidTools/actions/workflows/build-validation.yml)
- This is a [Portable Module](https://docs.microsoft.com/de-de/powershell/scripting/dev-cross-plat/writing-portable-modules?view=powershell-7).
- [VSCode](https://code.visualstudio.com) is recommended as IDE. [VSCode Tasks](https://code.visualstudio.com/docs/editor/tasks) are configured.
- Build automation is based on [InvokeBuild](https://github.com/nightroman/Invoke-Build)
- Test automation is based on [Pester](https://pester.dev)
- Commands are named based on [Approved Verbs for PowerShell Commands](https://docs.microsoft.com/de-de/powershell/scripting/developer/cmdlet/approved-verbs-for-windows-powershell-commands)
- This project uses [git-flow](https://github.com/nvie/gitflow).
- This project uses [keep a changelog](https://keepachangelog.com/en/1.0.0/).
- This project uses [PsBuildTasks](https://github.com/abbgrade/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.