Skip to content

Commit

Permalink
Merge branch 'main' into tikz
Browse files Browse the repository at this point in the history
to resolve conflict in smoke.js due to addition of wireviz

Conflicts:
      ci/tests/smoke.js
  • Loading branch information
rfdonnelly committed Mar 15, 2023
2 parents 86c6ada + a2e21f1 commit 8ccaae0
Show file tree
Hide file tree
Showing 66 changed files with 1,841 additions and 121 deletions.
2 changes: 1 addition & 1 deletion .github/workflows/cve-scan.yml
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ jobs:
continue-on-error: true
strategy:
matrix:
image: [ kroki, kroki-mermaid, kroki-bpmn, kroki-excalidraw, kroki-blockdiag, kroki-diagramsnet ]
image: [ kroki, kroki-mermaid, kroki-bpmn, kroki-excalidraw, kroki-blockdiag, kroki-diagramsnet, kroki-wireviz ]
tag: [ latest ]
steps:
- name: Run Trivy vulnerability scanner
Expand Down
9 changes: 9 additions & 0 deletions .github/workflows/dockerhub-description.yml
Original file line number Diff line number Diff line change
Expand Up @@ -64,3 +64,12 @@ jobs:
repository: yuzutech/kroki-diagramsnet
short-description: Companion server for Kroki that provides diagrams.net (formerly draw.io)
readme-filepath: ./DOCKERHUB-COMPANION.md

- name: Docker Hub Description - wireviz
uses: peter-evans/dockerhub-description@v3.1.2
with:
username: ${{ secrets.DOCKER_USERNAME }}
password: ${{ secrets.DOCKER_PASSWORD }}
repository: yuzutech/kroki-wireviz
short-description: Companion server for Kroki that provides WireViz
readme-filepath: ./DOCKERHUB-COMPANION.md
6 changes: 6 additions & 0 deletions DOCKERHUB.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,6 +40,7 @@ services:
- KROKI_MERMAID_HOST=mermaid
- KROKI_BPMN_HOST=bpmn
- KROKI_EXCALIDRAW_HOST=excalidraw
- KROKI_WIREVIZ_HOST=wireviz
ports:
- "8000:8000"
blockdiag:
Expand All @@ -58,6 +59,10 @@ services:
image: yuzutech/kroki-excalidraw
ports:
- "8004:8004"
wireviz:
image: yuzutech/kroki-wireviz
ports:
- "8006:8006"
```

If you don't want to use `docker-compose`, you can configure the host and port for each companion container using environment variables:
Expand All @@ -68,6 +73,7 @@ If you don't want to use `docker-compose`, you can configure the host and port f
| `kroki-mermaid` | `KROKI_MERMAID_HOST` | `KROKI_MERMAID_PORT` |
| `kroki-bpmn` | `KROKI_BPMN_HOST` | `KROKI_BPMN_PORT` |
| `kroki-excalidraw` | `KROKI_EXCALIDRAW_HOST` | `KROKI_EXCALIDRAW_PORT` |
| `kroki-wireviz` | `KROKI_WIREVIZ_HOST` | `KROKI_WIREVIZ_PORT` |

For Kubernetes installation follow the description in [install using Kubernetes](https://docs.kroki.io/kroki/setup/install/#_using_kubernetes) section.

Expand Down
3 changes: 2 additions & 1 deletion Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,8 @@ SERVICES_TIMEOUT=15
default:

installLocalDependencies:
mvn install:install-file -Dfile=./umlet/lib/umlet-mini-14.3.0.jar -DgroupId=com.umlet -DartifactId=umlet-mini -Dversion=14.3.0 -Dpackaging=jar
mvn install:install-file -Dfile=./umlet/lib/umlet-mini-15.0.0.jar -DgroupId=com.umlet -DartifactId=umlet-mini -Dversion=15.0.0 -Dpackaging=jar
mvn install:install-file -Dfile=./umlet/lib/umlet-parent-15.0.0.pom -DgroupId=com.umlet -DartifactId=umlet-parent -Dversion=15.0.0 -Dpackaging=pom
mvn install:install-file -Dfile=./server/lib/ditaamini-1.0.3.jar -DgroupId=ditaa -DartifactId=ditaa-mini -Dversion=1.0.3 -Dpackaging=jar

buildServer:
Expand Down
13 changes: 12 additions & 1 deletion README.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ image:https://github.com/yuzutech/kroki/workflows/CI/badge.svg?branch=master[Git
image:https://img.shields.io/badge/zulip-join_chat-brightgreen.svg[Zulip chat, link=https://kroki.zulipchat.com/]
endif::[]

{uri-kroki}[Kroki] provides a unified API with support for BlockDiag (BlockDiag, SeqDiag, ActDiag, NwDiag, PacketDiag, RackDiag), BPMN, Bytefield, C4 (with PlantUML), D2, DBML, Diagrams.net (experimental), Ditaa, Erd, Excalidraw, GraphViz, Mermaid, Nomnoml, Pikchr, PlantUML, SvgBob, UMLet, Vega, Vega-Lite and WaveDrom... and more to come!
{uri-kroki}[Kroki] provides a unified API with support for BlockDiag (BlockDiag, SeqDiag, ActDiag, NwDiag, PacketDiag, RackDiag), BPMN, Bytefield, C4 (with PlantUML), D2, DBML, Diagrams.net (experimental), Ditaa, Erd, Excalidraw, GraphViz, Mermaid, Nomnoml, Pikchr, PlantUML, SvgBob, UMLet, Vega, Vega-Lite, WaveDrom and WireViz... and more to come!

== Quickstart

Expand Down Expand Up @@ -109,6 +109,9 @@ A companion web server written in JavaScript (powered by _micro_) that provides
diagrams.net::
A companion web server written in JavaScript (powered by _micro_) that provides _diagrams.net_.

wireviz::
A companion web server written in Python (powered by _Flask_ and _Gunicorn_) that provides _WireViz_.

== Build

=== Gateway Server
Expand Down Expand Up @@ -154,6 +157,9 @@ Excalidraw
yuzutech/kroki-diagramsnet (experimental)::
diagrams.net

yuzutech/kroki-wireviz::
WireViz

You can use `docker-compose` to run multiple containers:

.docker-compose.yml
Expand All @@ -168,6 +174,7 @@ services:
- KROKI_MERMAID_HOST=mermaid
- KROKI_BPMN_HOST=bpmn
- KROKI_EXCALIDRAW_HOST=excalidraw
- KROKI_WIREVIZ_HOST=wireviz
ports:
- "8000:8000"
blockdiag:
Expand All @@ -191,6 +198,10 @@ services:
image: yuzutech/kroki-diagramsnet
expose:
- "8005"
wireviz:
image: yuzutech/kroki-wireviz
ports:
- "8006:8006"
----

$ docker-compose up -d
2 changes: 1 addition & 1 deletion SECURITY.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,4 +4,4 @@ If you have found a security issue or concern with Kroki please email the mainta

## Expectations

We will do everything we can to communicate in a timely manner and address your concerns, but realize that we do have day jobs and this is an open source project so have a little patience if you don't hear back from us immediatly.
We will do everything we can to communicate in a timely manner and address your concerns, but realize that we do have day jobs and this is an open source project so have a little patience if you don't hear back from us immediately.
4 changes: 3 additions & 1 deletion ci/tasks/update-versions.js
Original file line number Diff line number Diff line change
Expand Up @@ -121,7 +121,8 @@ const diagramLibraryNames = [
'umlet',
'vega',
'vegalite',
'wavedrom'
'wavedrom',
'wireviz'
]

try {
Expand Down Expand Up @@ -250,6 +251,7 @@ try {
await updateServiceGetVersion('Svgbob.java', diagramLibraryVersions.svgbob)
await updateServiceGetVersion('Umlet.java', diagramLibraryVersions.umlet)
await updateServiceGetVersion('Wavedrom.java', diagramLibraryVersions.wavedrom)
await updateServiceGetVersion('WireViz.java', diagramLibraryVersions.wireviz)
await updateVegaServiceGetVersion(diagramLibraryVersions.vega, diagramLibraryVersions.vegalite)

} catch (err) {
Expand Down
26 changes: 26 additions & 0 deletions ci/tests/diagrams/wireviz.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
connectors:
X1:
type: D-Sub
subtype: female
pinlabels: [DCD, RX, TX, DTR, GND, DSR, RTS, CTS, RI]
X2:
type: Molex KK 254
subtype: female
pinlabels: [GND, RX, TX]

cables:
W1:
gauge: 0.25 mm2
length: 0.2
color_code: DIN
wirecount: 3
shield: true

connections:
-
- X1: [5,2,3]
- W1: [1,2,3]
- X2: [1,3,2]
-
- X1: 5
- W1: s
6 changes: 6 additions & 0 deletions ci/tests/docker-compose.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@ services:
- KROKI_BPMN_HOST=bpmn
- KROKI_EXCALIDRAW_HOST=excalidraw
- KROKI_DIAGRAMSNET_HOST=diagramsnet
- KROKI_WIREVIZ_HOST=wireviz
ports:
- "8000:8000"

Expand Down Expand Up @@ -41,3 +42,8 @@ services:
image: yuzutech/kroki-diagramsnet:smoketests
expose:
- "8005"

wireviz:
image: yuzutech/kroki-wireviz:smoketests
ports:
- "8006:8006"
1 change: 1 addition & 0 deletions ci/tests/smoke.js
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,7 @@ const tests = [
{engine: 'diagramsnet', file: 'diagramsnet-ui.xml', outputFormat: ['svg', 'png']},
{engine: 'diagramsnet', file: 'diagramsnet-venn.xml', outputFormat: ['svg', 'png']},
{engine: 'd2', file: 'connections.d2', outputFormat: ['svg']},
{engine: 'wireviz', file: 'wireviz.yaml', outputFormat: ['svg', 'png']},
{engine: 'tikz', file: 'periodic-table.tex', outputFormat: ['jpeg', 'pdf', 'png', 'svg']}
]

Expand Down
14 changes: 7 additions & 7 deletions dbml/package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion dbml/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@
"keywords": [],
"author": "Bruno Obsomer",
"dependencies": {
"@softwaretechnik/dbml-renderer": "1.0.22"
"@softwaretechnik/dbml-renderer": "1.0.26"
},
"devDependencies": {
"standard": "17.0.0"
Expand Down
2 changes: 1 addition & 1 deletion diagrams.net/assets/stencils/aws/deployment_management.xml
Original file line number Diff line number Diff line change
Expand Up @@ -253,7 +253,7 @@
<fillstroke/>
</foreground>
</shape>
<shape name="AWS Elastic BeanStalk Applicaton" h="53.89" w="31.1" aspect="variable" strokewidth="inherit">
<shape name="AWS Elastic BeanStalk Application" h="53.89" w="31.1" aspect="variable" strokewidth="inherit">
<connections>
<constraint x="0.5" y="0.07" perimeter="0" name="N"/>
<constraint x="0.13" y="1" perimeter="0" name="S"/>
Expand Down
2 changes: 1 addition & 1 deletion diagrams.net/assets/stencils/office/servers.xml
Original file line number Diff line number Diff line change
Expand Up @@ -1678,7 +1678,7 @@
<fillstroke/>
</foreground>
</shape>
<shape aspect="variable" h="59.17" name="Excahnge Client Access Server Role" strokewidth="inherit" w="51.75">
<shape aspect="variable" h="59.17" name="Exchange Client Access Server Role" strokewidth="inherit" w="51.75">
<connections/>
<foreground>
<path>
Expand Down
4 changes: 4 additions & 0 deletions docker-bake-release.hcl
Original file line number Diff line number Diff line change
Expand Up @@ -24,3 +24,7 @@ target "kroki-excalidraw" {
target "kroki-diagramsnet" {
tags = ["yuzutech/kroki-diagramsnet:${RELEASE_VERSION}", "yuzutech/kroki-diagramsnet:latest"]
}

target "kroki-wireviz" {
tags = ["yuzutech/kroki-wireviz:${RELEASE_VERSION}", "yuzutech/kroki-wireviz:latest"]
}
6 changes: 5 additions & 1 deletion docker-bake.hcl
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ variable "TAG" {
}

group "default" {
targets = ["kroki", "kroki-blockdiag", "kroki-mermaid", "kroki-bpmn", "kroki-excalidraw", "kroki-diagramsnet"]
targets = ["kroki", "kroki-blockdiag", "kroki-mermaid", "kroki-bpmn", "kroki-excalidraw", "kroki-diagramsnet", "kroki-wireviz"]
}

target "kroki" {
Expand Down Expand Up @@ -45,3 +45,7 @@ target "kroki-diagramsnet" {
tags = ["yuzutech/kroki-diagramsnet:${TAG}"]
}

target "kroki-wireviz" {
context = "wireviz"
tags = ["yuzutech/kroki-wireviz:${TAG}"]
}
3 changes: 2 additions & 1 deletion docs/antora.yml
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ asciidoc:
bytefield-version: 1.7.0
c4plantuml-version: 1.2022.5
d2-version: 0.1.5
dbml-version: 1.0.22
dbml-version: 1.0.26
diagramsnet-version: 16.2.4
ditaa-version: 1.0.3
erd-version: 0.2.1.0
Expand All @@ -29,6 +29,7 @@ asciidoc:
vega-version: 5.22.1
vegalite-version: 5.6.0
wavedrom-version: 2.9.1
wireviz-version: 0.3.2
uri-docker-get-started: https://docs.docker.com/get-started/
uri-podman-get-started: https://podman.io/getting-started/
uri-docker-compose-install: https://docs.docker.com/compose/install/
Expand Down
18 changes: 16 additions & 2 deletions docs/modules/ROOT/pages/architecture.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -21,9 +21,12 @@ A companion web server written in JavaScript (powered by _micro_) that provides
Diagrams.net::
A companion web server written in JavaScript (powered by _micro_) that provides https://www.diagrams.net/[_diagrams.net_] to render diagrams.

WireViz::
A companion web server written in Python (powered by _Flask_ and _Gunicorn_) that provides WireViz.

== Gateway Server

The Docker image contains the following diagrams libraries out-of-the-box:
The `yuzutech/kroki` Docker image contains the following diagrams libraries out-of-the-box:

[options="header",cols="1,1m"]
|===
Expand Down Expand Up @@ -88,7 +91,7 @@ The Docker image contains the following diagrams libraries out-of-the-box:

=== BlockDiag

The `yuzutech/kroki` Docker image contains the following diagrams libraries out-of-the-box:
The `yuzutech/kroki-blockdiag` Docker image contains the following diagrams libraries out-of-the-box:

[options="header",cols="1,1m"]
|===
Expand Down Expand Up @@ -155,3 +158,14 @@ The `yuzutech/kroki-diagramsnet` Docker image contains the following diagrams li
|https://www.diagrams.net/[diagrams.net]
|{diagramsnet-version}
|===

=== WireViz

The `yuzutech/kroki-wireviz` Docker image contains the following diagrams libraries out-of-the-box:

[options="header",cols="1,1m"]
|===
|Diagram Type | Version
|https://github.com/formatc1702/WireViz[WireViz]
|{wireviz-version}
|===
1 change: 1 addition & 0 deletions docs/modules/ROOT/pages/diagram-types.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -40,6 +40,7 @@ Diagram::
* Bytefield diagram
* Excalidraw
* https://www.diagrams.net/[diagrams.net] (experimental)
* WireViz

Visualization::
* Bar charts
Expand Down
2 changes: 1 addition & 1 deletion docs/modules/ROOT/pages/index.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@

Kroki provides a unified HTTP API with support for BlockDiag (BlockDiag, SeqDiag, ActDiag, NwDiag, PacketDiag, RackDiag),
BPMN, Bytefield, C4 (with PlantUML), Diagrams.net (experimental), Ditaa, Erd, Excalidraw, GraphViz, Mermaid, Nomnoml, PlantUML, Structurizr, SvgBob, UMLet,
Vega, Vega-Lite and WaveDrom... and more to come!
Vega, Vega-Lite, WaveDrom and WireViz... and more to come!

Kroki is available as a Self-Managed instance. +
We are also _actively_ looking for sponsors to provide Kroki as a free service:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,8 @@ spec:
value: excalidraw
- name: KROKI_MERMAID_HOST
value: mermaid
- name: KROKI_WIREVIZ_HOST
value: wireviz
image: yuzutech/kroki
name: kroki
ports:
Expand Down
23 changes: 23 additions & 0 deletions docs/modules/setup/examples/k8s-multi-pod/wireviz-deployment.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
apiVersion: apps/v1
kind: Deployment
metadata:
annotations:
labels:
app: wireviz
name: wireviz
spec:
replicas: 1
selector:
matchLabels:
app: wireviz
template:
metadata:
labels:
app: wireviz
spec:
containers:
- image: yuzutech/kroki-wireviz
name: wireviz
ports:
- containerPort: 8006
restartPolicy: Always
15 changes: 15 additions & 0 deletions docs/modules/setup/examples/k8s-multi-pod/wireviz-service.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
---
apiVersion: v1
kind: Service
metadata:
annotations:
labels:
app: wireviz
name: wireviz
spec:
ports:
- name: "8006"
port: 8006
targetPort: 8006
selector:
app: wireviz
Loading

0 comments on commit 8ccaae0

Please sign in to comment.