From 18dd6b03ade96536c8930a3e4d3b4d5a626d5ee3 Mon Sep 17 00:00:00 2001 From: Jonas Lindholm Date: Mon, 17 May 2021 14:22:32 +0200 Subject: [PATCH 1/7] companion images description in a common file --- .github/workflows/dockerhub-description.yml | 36 +++++++++++++++++++++ DOCKERHUB-COMPANION.md | 21 ++++++++++++ 2 files changed, 57 insertions(+) create mode 100644 DOCKERHUB-COMPANION.md diff --git a/.github/workflows/dockerhub-description.yml b/.github/workflows/dockerhub-description.yml index 599d69279..d10d1b7eb 100644 --- a/.github/workflows/dockerhub-description.yml +++ b/.github/workflows/dockerhub-description.yml @@ -19,3 +19,39 @@ jobs: repository: yuzutech/kroki short-description: ${{ github.event.repository.description }} readme-filepath: ./DOCKERHUB.md + + - name: Docker Hub Description - bpmn + uses: peter-evans/dockerhub-description@v2.4.2 + with: + username: ${{ secrets.DOCKER_USERNAME }} + password: ${{ secrets.DOCKER_PASSWORD }} + repository: yuzutech/kroki-bpmn + short-description: Companion image for BPMN to use with kroki server + readme-filepath: ./DOCKERHUB-COMPANION.md + + - name: Docker Hub Description - excalidraw + uses: peter-evans/dockerhub-description@v2.4.2 + with: + username: ${{ secrets.DOCKER_USERNAME }} + password: ${{ secrets.DOCKER_PASSWORD }} + repository: yuzutech/kroki-excalidraw + short-description: Companion image for excalidraw to use with kroki server + readme-filepath: ./DOCKERHUB-COMPANION.md + + - name: Docker Hub Description - mermaid + uses: peter-evans/dockerhub-description@v2.4.2 + with: + username: ${{ secrets.DOCKER_USERNAME }} + password: ${{ secrets.DOCKER_PASSWORD }} + repository: yuzutech/kroki-mermaid + short-description: Companion image for mermaid to use with kroki server + readme-filepath: ./DOCKERHUB-COMPANION.md + + - name: Docker Hub Description - blockdiag + uses: peter-evans/dockerhub-description@v2.4.2 + with: + username: ${{ secrets.DOCKER_USERNAME }} + password: ${{ secrets.DOCKER_PASSWORD }} + repository: yuzutech/kroki-blockdiag + short-description: Companion image for blockdiag to use with kroki server + readme-filepath: ./DOCKERHUB-COMPANION.md diff --git a/DOCKERHUB-COMPANION.md b/DOCKERHUB-COMPANION.md new file mode 100644 index 000000000..55608d906 --- /dev/null +++ b/DOCKERHUB-COMPANION.md @@ -0,0 +1,21 @@ +# Kroki Companion Image + +Image to use together with this server: [yuzutech/kroki](https://hub.docker.com/r/yuzutech/kroki) + +GitHub repository: [kroki](https://github.com/yuzutech/kroki) + +## Usage + +Use this images with: +* [Docker-compose](https://docs.kroki.io/kroki/setup/install/#_using_docker_compose) +* [Kubernetes](https://docs.kroki.io/kroki/setup/install/#_using_kubernetes) + +For installation and configuration see [Kroki docs](https://docs.kroki.io/) + +## Versioning + +We use [SemVer](https://semver.org/) for versioning. + +## License + +This project is licensed under the MIT License. From 4617744c522c447df932c8706bb467879cf05bd8 Mon Sep 17 00:00:00 2001 From: lind Date: Thu, 20 May 2021 20:15:31 +0200 Subject: [PATCH 2/7] Update .github/workflows/dockerhub-description.yml Co-authored-by: Guillaume Grossetie --- .github/workflows/dockerhub-description.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/dockerhub-description.yml b/.github/workflows/dockerhub-description.yml index d10d1b7eb..611b9f17a 100644 --- a/.github/workflows/dockerhub-description.yml +++ b/.github/workflows/dockerhub-description.yml @@ -53,5 +53,5 @@ jobs: username: ${{ secrets.DOCKER_USERNAME }} password: ${{ secrets.DOCKER_PASSWORD }} repository: yuzutech/kroki-blockdiag - short-description: Companion image for blockdiag to use with kroki server + short-description: Companion server for Kroki that provides BlockDiag, SeqDiag, ActDiag, NwDiag, PacketDiag and RackDiag readme-filepath: ./DOCKERHUB-COMPANION.md From 88388aac12666abf9be9c039f93f0cc0e43a1a58 Mon Sep 17 00:00:00 2001 From: lind Date: Thu, 20 May 2021 20:16:28 +0200 Subject: [PATCH 3/7] Update DOCKERHUB-COMPANION.md Co-authored-by: Guillaume Grossetie --- DOCKERHUB-COMPANION.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/DOCKERHUB-COMPANION.md b/DOCKERHUB-COMPANION.md index 55608d906..765d7f3fe 100644 --- a/DOCKERHUB-COMPANION.md +++ b/DOCKERHUB-COMPANION.md @@ -1,6 +1,6 @@ # Kroki Companion Image -Image to use together with this server: [yuzutech/kroki](https://hub.docker.com/r/yuzutech/kroki) +Provides additional diagram libraries to [yuzutech/kroki](https://hub.docker.com/r/yuzutech/kroki). GitHub repository: [kroki](https://github.com/yuzutech/kroki) From e6413a2f8a495a81278f843c687742b4e8d29a2b Mon Sep 17 00:00:00 2001 From: lind Date: Thu, 20 May 2021 20:17:36 +0200 Subject: [PATCH 4/7] Update DOCKERHUB-COMPANION.md Co-authored-by: Guillaume Grossetie --- DOCKERHUB-COMPANION.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/DOCKERHUB-COMPANION.md b/DOCKERHUB-COMPANION.md index 765d7f3fe..578cf0ad1 100644 --- a/DOCKERHUB-COMPANION.md +++ b/DOCKERHUB-COMPANION.md @@ -2,7 +2,7 @@ Provides additional diagram libraries to [yuzutech/kroki](https://hub.docker.com/r/yuzutech/kroki). -GitHub repository: [kroki](https://github.com/yuzutech/kroki) +Read the [Kroki installation](https://docs.kroki.io/kroki/setup/install/#_images) to learn how to start Kroki companion containers. ## Usage From 89e930cc27f7dac6dff6f2d7ad7479e6c62b8371 Mon Sep 17 00:00:00 2001 From: lind Date: Thu, 20 May 2021 20:18:29 +0200 Subject: [PATCH 5/7] Update DOCKERHUB-COMPANION.md Co-authored-by: Guillaume Grossetie --- DOCKERHUB-COMPANION.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/DOCKERHUB-COMPANION.md b/DOCKERHUB-COMPANION.md index 578cf0ad1..6f7b327b1 100644 --- a/DOCKERHUB-COMPANION.md +++ b/DOCKERHUB-COMPANION.md @@ -10,7 +10,7 @@ Use this images with: * [Docker-compose](https://docs.kroki.io/kroki/setup/install/#_using_docker_compose) * [Kubernetes](https://docs.kroki.io/kroki/setup/install/#_using_kubernetes) -For installation and configuration see [Kroki docs](https://docs.kroki.io/) +To learn more about Kroki, read the [documentation](https://docs.kroki.io/). ## Versioning From 6cb67f511984fb1864366a90c411f62dec37e449 Mon Sep 17 00:00:00 2001 From: lind Date: Thu, 20 May 2021 20:18:44 +0200 Subject: [PATCH 6/7] Update DOCKERHUB-COMPANION.md Co-authored-by: Guillaume Grossetie --- DOCKERHUB-COMPANION.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/DOCKERHUB-COMPANION.md b/DOCKERHUB-COMPANION.md index 6f7b327b1..d7d9ff31b 100644 --- a/DOCKERHUB-COMPANION.md +++ b/DOCKERHUB-COMPANION.md @@ -7,7 +7,7 @@ Read the [Kroki installation](https://docs.kroki.io/kroki/setup/install/#_images ## Usage Use this images with: -* [Docker-compose](https://docs.kroki.io/kroki/setup/install/#_using_docker_compose) +* [docker-compose](https://docs.kroki.io/kroki/setup/install/#_using_docker_compose) * [Kubernetes](https://docs.kroki.io/kroki/setup/install/#_using_kubernetes) To learn more about Kroki, read the [documentation](https://docs.kroki.io/). From 80f9ec82a63bb45e6fcadd7300d5dd8688758396 Mon Sep 17 00:00:00 2001 From: Jonas Lindholm Date: Thu, 20 May 2021 21:26:48 +0200 Subject: [PATCH 7/7] description fixes --- .github/workflows/dockerhub-description.yml | 6 +++--- DOCKERHUB-COMPANION.md | 2 +- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/.github/workflows/dockerhub-description.yml b/.github/workflows/dockerhub-description.yml index 611b9f17a..c060170ab 100644 --- a/.github/workflows/dockerhub-description.yml +++ b/.github/workflows/dockerhub-description.yml @@ -26,7 +26,7 @@ jobs: username: ${{ secrets.DOCKER_USERNAME }} password: ${{ secrets.DOCKER_PASSWORD }} repository: yuzutech/kroki-bpmn - short-description: Companion image for BPMN to use with kroki server + short-description: Companion server for Kroki that provides BPMN readme-filepath: ./DOCKERHUB-COMPANION.md - name: Docker Hub Description - excalidraw @@ -35,7 +35,7 @@ jobs: username: ${{ secrets.DOCKER_USERNAME }} password: ${{ secrets.DOCKER_PASSWORD }} repository: yuzutech/kroki-excalidraw - short-description: Companion image for excalidraw to use with kroki server + short-description: Companion server for Kroki that provides Excalidraw readme-filepath: ./DOCKERHUB-COMPANION.md - name: Docker Hub Description - mermaid @@ -44,7 +44,7 @@ jobs: username: ${{ secrets.DOCKER_USERNAME }} password: ${{ secrets.DOCKER_PASSWORD }} repository: yuzutech/kroki-mermaid - short-description: Companion image for mermaid to use with kroki server + short-description: Companion server for Kroki that provides Mermaid readme-filepath: ./DOCKERHUB-COMPANION.md - name: Docker Hub Description - blockdiag diff --git a/DOCKERHUB-COMPANION.md b/DOCKERHUB-COMPANION.md index d7d9ff31b..e49725e5f 100644 --- a/DOCKERHUB-COMPANION.md +++ b/DOCKERHUB-COMPANION.md @@ -1,4 +1,4 @@ -# Kroki Companion Image +# Kroki Companion Server Provides additional diagram libraries to [yuzutech/kroki](https://hub.docker.com/r/yuzutech/kroki).