Skip to content

Latest commit

 

History

History
170 lines (96 loc) · 6.32 KB

README.md

File metadata and controls

170 lines (96 loc) · 6.32 KB
Raw

gardener

gardener

GitHub release (latest by date) Go Report Card codecov SBOM

A utility that renders PlantUML diagram source in Markdown image tags.

Overview

PlantUML is a great application that allows users to create "Diagrams as Code". It has a simple syntax, is a fantastic way to render any diagram, and abstracts a lot of the tedious work needed to draw diagrams in an editor.

At DKFM, when we develop PlantUML documents, we like to have a way for readers to view them without having to download code and generate diagrams. gardener helps us do this. We can either run the executable manually, or use a pre-commit hook helper like hooks to continuously generate diagrams before code is committed to a central repository.

Installation

Mac

You can use Homebrew to install gardener using the following:

brew tap devops-kung-fu/homebrew-tap
brew install devops-kung-fu/homebrew-tap/gardener

If you do not have Homebrew, you can still download the latest release (ex: gardener_1.0.1_darwin_all.tar.gz), extract the files from the archive, and use the gardener binary.

If you wish, you can move the gardener binary to your /usr/local/bin directory or anywhere on your path.

Linux

To install gardener, download the latest release for your platform and install locally. For example, install gardener on Ubuntu:

dpkg -i gardener_1.0.1_linux_arm64.deb

Windows

To install gardener on Windows download the latest release, extract, put somewhere on your PATH, and use.

File Support

gardener will process the following PlantUML and Markdown extensions:

PlantUML

  • .pu
  • .puml
  • .plantuml
  • .iuml
  • .wsd

Markdown

  • .md

Modifying your Markdown for gardener support

Let's say you have our diagram source in diagrams/src/alicenbob.pu and we want to render it in README.md. All you need to do is add the following line where we'd want to display the UML in our Markdown.

NOTE: Insert the path to the diagram source in the alt text (the part in brackets) of the image tag.

![diagrams/src/alicenbob.pu]()

gardener will handle the rest and take care of finding diagram source files, markdown files, and image source and then will update the links in your Markdown.

Example

@startuml
Alice -> Bob: Authentication Request
Bob --> Alice: Authentication Response

Alice -> Bob: Another authentication Request
Alice <-- Bob: Another authentication Response
@enduml
# My Markdown File

Below is the image tag that gardner will update

![diagrams/src/alicenbob.pu]()

Usage

CLI Usage

The easist way to use gardener without any integration with CI/CD or pre-commit hooks is to simply install and run the executable.

Example:

gardener generate .

This example will scan the current directory and update any Markdown it finds where a PlantUML URL exists in the alt tag of an image with a link which will ultimately render an image after gardener processes the file.

Options

The default behavior of gardener is to deflate any generated image URLs to the smallest URL it can. If you don't want to deflate the URL you can use the deflate flag.

Example:

gardener generate --deflate=false .

Should you want to suppress all output, you can use the verbose flag and set it to false as follows:

gardener generate --verbose=false .

If you want to get really into what gardener is doing under the hood, you can add the --debug flag to your command and you'll get extended output.

Usage with hookz

gardner is best used with hookz so that diagram links are generated every time you commit code to your remote repository. To enable this functionality, follow the instructions to install hookz and then configure your .hookz.yaml file to add the following action:

NOTE: Ensure that for the url value you select the appropriate gardener release for your platform and architecture.

version: 2.4.0
hooks:
  - type: pre-commit
    actions:
      - name: "Generate Images for PlantUML"
        url: https://github.com/devops-kung-fu/gardener/releases/download/v1.0.0/gardener-1.0.0-linux-amd64
        args: ["deflate"]

Examples

Here are some examples from processed from diagrams/src/example1.pu and diagrams/src/example2.pu. View the source of this README.md page to see the URL's that gardener has created.

diagrams/src/example1.pu

diagrams/src/example1.pu

diagrams/src/example2.pu

diagrams/src/example2.pu

Software Bill of Materials

gardener uses the CycloneDX to generate a Software Bill of Materials in CycloneDX format (v1.4) every time a developer commits code to this repository. More information for CycloneDX is available here

The SBoM for the last commit of gardener is available here.

Credits

A big thank-you to our friends at Freepik for the Gardener logo.