v0.10.0

Changelog

This release includes a few improvements regarding /c4plantuml and /plantuml.
It also contains the latest available versions of:

• BPMN
• PlantUML
• Vega

Breaking changes

• Upgrade C4 definition files from 1.0.0 to 2.0.0

Bug fixes

• Use executeBlocking block to avoid blocking the event loop thread (#508)

Improvements

• Consolidate PlantUML and C4 PlantUML service
  • Upgrade C4 definition files (see breaking changes)
  • Add c4_dynamic and c4_deployment definition files
  • Use the same service for both /c4plantuml and /plantuml
• Upgrade BPMN from 7.5.0 to 8.0.1
• Upgrade PlantUML from 1.2020.23 to 1.2021.0
• Upgrade Vega from 5.17.0 to 5.17.3

Infrastructure

• Specify the logging backend on Vertx using the vertx.logger-delegate-factory-class-name variable
• Upgrade dependencies
  • Bump python from 3.8.6-alpine3.11 to 3.8.7-alpine3.11 in /blockdiag
  • Bump reportlab from 3.5.56 to 3.5.59 in /blockdiag

Documentation

• Add missing KROKI_EXCALIDRAW_HOST in the README

📄 Full diff
📖 Documentation

v0.9.0

Changelog

This release includes a new diagram library, welcome Excalidraw! 🎉
This diagram library is available at /excalidraw

This release also contains the latest available versions of:

• BPMN
• Mermaid
• Nomnoml
• PlantUML

Bug fixes

• Make sure that exceptions are correctly translated to errors (#508)

Improvements

• Upgrade BPMN from 7.4.0 to 7.4.1
• Upgrade Mermaid from 8.8.2 to 8.8.3
• Upgrade Nomnoml from 1.2.0 to 1.3.1
• Upgrade PlantUML from 1.2020.19 to 1.2020.23

Infrastructure

• Add dependabot config file
• Add diagram library licenses under /licenses directory
• Remove CodeQL integration as it does not produce any meaningful result
• Enable GitHub Sponsor
• Limit GitHub Actions events
• Upgrade dependencies
  • Bump alpine from 3.12.1 to 3.12.2 in /mermaid
  • Bump alpine from 3.12.1 to 3.12.2 in /bpmn
  • Bump puppeteer from 5.3.1 to 5.4.1 in /mermaid
  • Bump puppeteer from 5.3.1 to 5.4.1 in /bpmn
  • Bump reportlab from 3.5.53 to 3.5.56 in /blockdiag
  • Bump yargs from 16.0.3 to 16.1.0 in /vega
• Upgrade development dependencies
  • Bump mocha from 8.2.0 to 8.2.1
  • Bump mockito-core from 3.5.15 to 3.6.0
  • Bump assertj-core from 3.17.2 to 3.18.0
  • Bump standard from 15.0.0 to 16.0.1 in /bpmn
  • Bump standard from 15.0.0 to 16.0.1 in /vega
  • Bump standard from 15.0.0 to 16.0.1 in /nomnoml
  • Bump standard from 15.0.0 to 16.0.1 in /mermaid
  • Bump standard from 15.0.0 to 16.0.1 in /bytefield
  • Bump git-commit-id-plugin from 4.0.2 to 4.0.3
  • Bump ini from 1.3.5 to 1.3.8 in /vega

Documentation

• Extract the configuration into a dedicated page
• Add missing environment variables in the README: KROKI_VEGA_BIN_PATH, KROKI_WAVEDROM_BIN_PATH and KROKI_BYTEFIELD_BIN_PATH
• Fix a cross-reference link on the Usage page (to the HTTP clients page)
• Add bytefield and wavedrom in the project layout section on the README
• Add an example on how to encode a diagram definition using PHP
• Document on how to configure the host and port on which every companion container will be listening using environment variables

📄 Full diff
📖 Documentation

v0.8.0

Changelog

This release contains the latest available versions of:

• BPMN
• Mermaid
• Nomnoml
• PlantUML
• Vega
• Vega-Lite

We've also introduced a new API that returns a simple status on the health of the server and the diagram libraries versions.
This API is available at:

• /health
• /v1/health: versioned URL (alias)
• /healthz: k8s liveness default URL (alias)

Here's a response example:

{
  "status": "pass",
  "version": {
    "kroki": {
      "number": "0.7.1",
      "build_hash": "3ce18ec"
    },
    "actdiag": "2.0.0",
    "umlet": "14.3.0",
    "bpmn": "7.3.0",
    "nwdiag": "2.0.0",
    "c4plantuml": "1.2020.15",
    "plantuml": "1.2020.15",
    "nomnoml": "0.7.2",
    "rackdiag": "2.0.0",
    "seqdiag": "2.0.0",
    "wavedrom": "2.3.2",
    "bytefield": "1.5.0",
    "mermaid": "8.7.0",
    "erd": "0.1.3.0",
    "graphviz": "2.40.1",
    "packetdiag": "2.0.0",
    "vegalite": "4.14.1",
    "ditaa": "1.3.13",
    "svgbob": "0.4.2",
    "vega": "5.13.0",
    "blockdiag": "2.0.1"
  }
}

Improvements

• Add an health check API (#329) - big thanks to @llaville!
• Use an explicit height and width on all Mermaid diagrams. It makes it easier to display SVG images using an <img> element (#432)
• Upgrade BPMN from 7.3.0 to 7.4.0
• Upgrade Mermaid from 8.7.0 to 8.8.2
• Upgrade Nomnoml from 0.8.0 to 1.2.0
• Upgrade PlantUML from 1.2020.15 to 1.2020.19
• Upgrade Vega from 5.13.0 to 5.17.0
• Upgrade Vega Lite from 4.14.1 to 4.17.0

Infrastructure

• Add a LICENSE file

• Upgrade dependencies

  • Bump vertx.version from 3.9.2 to 3.9.4
  • Bump node from 12.18.3-alpine3.11 to 12.19.0-alpine3.11 in /bytefield
  • Bump node from 12.18.3-alpine3.11 to 12.19.0-alpine3.11 in /mermaid
  • Bump node from 12.18.3-alpine3.11 to 12.19.0-alpine3.11 in /bpmn
  • Bump node from 12.18.3-alpine3.11 to 12.19.0-alpine3.11 in /nomnoml
  • Bump python from 3.8.5-alpine3.11 to 3.8.6-alpine3.11 in /blockdiag
  • Bump puppeteer from 5.2.1 to 5.3.1 in /mermaid
  • Bump puppeteer from 5.2.1 to 5.3.1 in /bpmn
  • Bump reportlab from 3.5.47 to 3.5.53 in /blockdiag
  • Bump yargs from 15.4.1 to 16.0.3 in /vega
  • Bump node-fetch from 2.6.0 to 2.6.1 in /vega

• Upgrade development dependencies

  • Bump mocha from 8.1.1 to 8.2.0
  • Bump mockito-core from 3.4.6 to 3.5.15
  • Bump junit.jupiter.version from 5.6.2 to 5.7.0
  • Bump assertj-core from 3.16.1 to 3.17.2
  • Bump standard from 14.3.4 to 15.0.0 in /bpmn
  • Bump standard from 14.3.4 to 15.0.0 in /vega
  • Bump standard from 14.3.4 to 15.0.0 in /nomnoml
  • Bump standard from 14.3.4 to 15.0.0 in /mermaid
  • Bump standard from 14.3.4 to 15.0.0 in /bytefield
  • Bump bl from 4.0.2 to 4.0.3 in /bpmn
  • Bump bl from 4.0.2 to 4.0.3 in /mermaid

Documentation

• Update Docker Hub URLs
• Update the list of diagrams libraries available in yuzutech/kroki image
• Use SVG badge for Gitter on README

📄 Full diff
📖 Documentation

v0.7.1

Changelog

This release contains the latest available versions of:

• BPMN
• Bytefield
• Mermaid
• Vega-Lite

Improvements

• Upgrade BPMN from 7.2.1 to 7.3.0
• Upgrade Bytefield from 1.4.3 to 1.5.0
• Upgrade Mermaid from 8.5.2 to 8.7.0
• Upgrade Vega-Lite from 4.13.1 to 4.14.1

Infrastructure

• Upgrade dependencies

  • Bump python from 3.8.4-alpine3.11 to 3.8.5-alpine3.11 in /blockdiag
  • Bump node from 12.18.2-alpine3.11 to 12.18.3-alpine3.11 in /mermaid
  • Bump node from 12.18.2-alpine3.11 to 12.18.3-alpine3.11 in /bpmn
  • Bump node from 12.18.2-alpine to 12.18.3-alpine in /bytefield
  • Bump node from 12.18.2-alpine to 12.18.3-alpine in /nomnoml
  • Bump node from 10.21.0-alpine3.11 to 10.22.0-alpine3.11 i in /vega
  • Bump puppeteer from 5.1.0 to 5.2.1 in /bpmn
  • Bump puppeteer from 5.1.0 to 5.2.1 in /mermaid

• Upgrade development dependencies

  • Bump git-commit-id-plugin from 4.0.1 to 4.0.2
  • Bump mocha from 8.0.1 to 8.1.1
  • Bump mockito-core from 3.4.2 to 3.4.6
  • Bump pillow from 7.1.2 to 7.2.0 in /blockdiag
  • Bump reportlab from 3.5.44 to 3.5.47 in /blockdiag

📄 Full diff
📖 Documentation

v0.6.0

Changelog

This release contains the latest available versions of:

• BPMN
• Mermaid
• PlantUML
• Vega
• Vega-Lite

Improvements

• Upgrade BPMN from 6.5.1 to 7.2.1
• Upgrade Mermaid from 8.5.1 to 8.5.2
• Upgrade PlantUML from 1.2020.10 to 1.2020.15
• Upgrade Vega from 5.12.1 to 5.13.0
• Upgrade Vega-Lite from 4.12.2 to 4.13.1
• Add User-Agent in the Mapped Diagnostic Context (MDC)
• Remove logback-jackson and jackson-databind dependencies

Infrastructure

• Upgrade dependencies
  • Bump vertx from 3.9.1 to 3.9.2
  • Bump reportlab from 3.5.42 to 3.5.44 in /blockdiag
  • Bump node from 12.16.3-alpine to 12.18.2-alpine in /bpmn
  • Bump node from 12.16.3-alpine to 12.18.2-alpine in /bytefield
  • Bump node from 12.16.3-alpine3.11 to 12.18.2-alpine3.11 in /mermaid
  • Bump node from 12.16.3-alpine3.11 to 12.18.2-alpine3.11 in /nomnoml
  • Bump node from 10.20.1-alpine3.11 to 10.21.0-alpine3.11 in /vega
  • Bump python from 3.8.3-alpine3.11 to 3.8.4-alpine3.11 in /blockdiag
  • Bump puppeteer from 3.1.0 to 5.1.0 in /mermaid
  • Bump puppeteer from 3.1.0 to 5.1.0 in /bpmn
• Upgrade development dependencies
  • Bump mocha from 7.1.2 to 7.2.0
  • Bump maven-shade-plugin from 3.2.3 to 3.2.4
  • Bump standard from 14.3.3 to 14.3.4 in /vega
  • Bump standard from 14.3.3 to 14.3.4 in /bpmn
  • Bump standard from 14.3.3 to 14.3.4 in /nomnoml
  • Bump standard from 14.3.3 to 14.3.4 in /bytefield
  • Bump yargs from 15.3.1 to 15.4.1 in /vega
  • Bump lodash from 4.17.15 to 4.17.19
  • Bump assertj-core from 3.15.0 to 3.16.1
  • Bump mockito-core from 3.3.3 to 3.4.2

Documentation

• Link to the releases listing page of the kroki-cli - thanks @ferdnyc

📄 Full diff
📖 Documentation

v0.5.0

Changelog

This release contains the latest available versions of:

• Bytefield,
• Nomnoml,
• Mermaid,
• PlantUML,
• Vega
• and Vega-Lite!

We've also introduced a new feature to configure the PlantUML !include directive using environment variables:

• KROKI_PLANTUML_INCLUDE_PATH: The include path to set for PlantUML.
• KROKI_PLANTUML_INCLUDE_WHITELIST: The name of a file that consists of a list of Java regular expressions for valid includes.
• KROKI_PLANTUML_INCLUDE_WHITELIST_0, KROKI_PLANTUML_INCLUDE_WHITELIST_1...: One regex to add to the include whitelist per environment variable. Search will stop at the first empty or undefined integer number.
• KROKI_PLANTUML_ALLOW_INCLUDE: Either false (default) or true.
  Determines if PlantUML will fetch !include directives that reference external URLs. For example, PlantUML allows the !import directive to pull fragments from the filesystem or a remote URL or the standard library.

In addition, we've added a new safe mode SAFE:

• SECURE (default) - Paranoid sanitization of requests before passing to the diagram library.
• SAFE - Assume the diagram libraries secure mode request sanitization is sufficient
• UNSAFE - Run the diagram libraries without request sanitization.

We encourage anyone running their own Kroki server to review PlantUML code and select the security mode appropriate for their use case.

We would like to thank @stephenc for these great contributions! 🎉

Improvements

• Introduce a new safe mode SAFE - thanks Stephen
• Allow configuration of PlantUML includes - thanks Stephen
• Upgrade Mermaid from 8.5.0 to 8.5.1
• Upgrade Vega from 5.11.1 to 5.12.1
• Upgrade Bytefield from 1.4.1 to 1.4.3
• Upgrade PlantUML from 1.2020.8 to 1.2020.10
• Upgrade Nomnoml from 0.7.1 to 0.7.2
• Upgrade Vega-Lite from 4.11.0 to 4.12.2

Infrastructure

• Upgrade dependencies
  • Bump python from 3.8.2-alpine3.11 to 3.8.3-alpine3.11 in /blockdiag
  • Bump node from 12.16.2-alpine3.11 to 12.16.3-alpine3.11 in /bpmn
  • Bump node from 12.16.2-alpine to 12.16.3-alpine in /bytefield
  • Bump node from 10.20.0-alpine3.11 to 10.20.1-alpine3.11 in /vega
  • Bump node from 12.16.2-alpine3.11 to 12.16.3-alpine3.11 in /mermaid
  • Bump node from 12.16.2-alpine3.11 to 12.16.3-alpine3.11 in /nomnoml
  • Bump puppeteer from 3.0.2 to 3.1.0 in /mermaid
  • Bump puppeteer from 3.0.2 to 3.1.0 in /bpmn
  • Bump vertx from 3.9.0 to 3.9.1
• Upgrade development dependencies
  • Bump standard from 14.3.3 to 14.3.4 in /mermaid
  • Bump standard from 14.3.3 to 14.3.4 in /vega
  • Bump standard from 14.3.3 to 14.3.4 in /bpmn
  • Bump standard from 14.3.3 to 14.3.4 in /nomnoml
  • Bump standard from 14.3.3 to 14.3.4 in /bytefield
  • Bump assertj-core from 3.15.0 to 3.16.1

📄 Full diff
📖 Documentation

v0.4.1

Changelog

Bug fixes

• Do not use the embedded mode in bytefield (#198)

📄 Full diff
📖 Documentation

v0.4.0

Changelog

This release introduces two new diagrams libraries:

• /bytefield : Bytefield diagrams using bytefield-svg

• /bpmn : BPMN diagrams using bpmn-js

Improvements

• Add BPMN support with bpmn-js 🎉 - thanks @nekator
• Add bytefield support with bytefield-svg - thanks @brunchboy
• Upgrade Vega 5.10.0 to 5.11.1
• Upgrade Vega-Lite from 4.8.1 to 4.11.0
• Upgrade PlantUML from 1.2020.4 to 1.2020.8
• Upgrade Nomnoml from 0.6.2 to 0.7.1
• Upgrade Mermaid from 8.4.8 to 8.5.0

Infrastructure

• Migrate CI to GitHub Actions 🤖 - thanks @groovytron
• Upgrade dependencies
  • vertx from 3.8.5 to 3.9.0
  • werkzeug from 1.0.0 to 1.0.1
  • pillow from 7.0.0 to 7.1.2
  • flask from 1.1.1 to 1.1.2
  • jinja2 from 2.11.1 to 2.11.2
  • puppeteer from 2.1.1 to 3.0.2
  • jackson-databind from 2.9.10.3 to 2.9.10.4
  • click from 7.1.1 to 7.1.2
• Upgrade Docker base images
  • Node from 12.16.1-alpine to 12.16.2-alpine3.11
  • Java from openjdk:8u191-jdk-alpine3.8 to adoptopenjdk/openjdk11:jre-11.0.6_10-alpine (Alpine 3.11)
• Remove unused Dockerfile
• Remove docker tag tasks
• Add Gitter badge on README
• Add GitHub Actions badge on README - thanks @groovytron
• Run standard linter on JavaScript code

Documentation

• Expose supporting containers internally, not publicly in documentation - thanks @tkfu
• Use literal blocks for command line output

📄 Full diff
📖 Documentation

v0.3.0

Changelog

Bug fixes

• Fix duplicate content using BlockDiag (BlockDiag, SeqDiag, ActDiag, NwDiag, PacketDiag, RackDiag) #137
• Make sure that there is no more data in the stdout stream

Improvements

• Upgrade PlantUML from 1.2020.3 to 1.2020.4
• Upgrade Vega-Lite from 4.7.0 to 4.8.1.
• Allow to configure the command timeout (5 seconds by default) using KROKI_COMMAND_TIMEOUT
• Allow to configure the read stdout timeout (2 seconds by default) using KROKI_COMMAND_READ_STDOUT_TIMEOUT

Infrastructure

• Upgrade dependencies
  • alpine from 3.11.3 to 3.11.5 (Mermaid container)
  • junit from 5.6.0 to 5.6.1

📄 Full diff
📖 Documentation

v0.2.0

Changelog

Bug fixes

• Fix an issue with Vega and Vega-Lite export to PDF and PNG. Revert to Node 10.15.0 as canvas is incompatible with Node 12.16.1 on Alpine.

Improvements

• Upgrade PlantUML from 1.2020.2 to 1.2020.3
• Add Kroki version and SHA1 to hello page

Infrastructure

• Upgrade dependencies
  • mockito-core from 3.3.0 to 3.3.3
  • standard from 14.3.1 to 14.3.3
  • mocha from 7.1.0 to 7.1.1
  • yargs from 15.3.0 to 15.3.1
  • reportlab from 3.5.34 to 3.5.42

📄 Full diff
📖 Documentation