Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Update companion images description on Docker Hub #753

Merged
merged 7 commits into from
May 22, 2021
Merged

Update companion images description on Docker Hub #753

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
18dd6b0
companion images description in a common file
lind May 17, 2021
4617744
Update .github/workflows/dockerhub-description.yml
lind May 20, 2021
88388aa
Update DOCKERHUB-COMPANION.md
lind May 20, 2021
e6413a2
Update DOCKERHUB-COMPANION.md
lind May 20, 2021
89e930c
Update DOCKERHUB-COMPANION.md
lind May 20, 2021
6cb67f5
Update DOCKERHUB-COMPANION.md
lind May 20, 2021
80f9ec8
description fixes
lind May 20, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
36 changes: 36 additions & 0 deletions .github/workflows/dockerhub-description.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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/[email protected]
with:
username: ${{ secrets.DOCKER_USERNAME }}
password: ${{ secrets.DOCKER_PASSWORD }}
repository: yuzutech/kroki-bpmn
short-description: Companion server for Kroki that provides BPMN
readme-filepath: ./DOCKERHUB-COMPANION.md

- name: Docker Hub Description - excalidraw
uses: peter-evans/[email protected]
with:
username: ${{ secrets.DOCKER_USERNAME }}
password: ${{ secrets.DOCKER_PASSWORD }}
repository: yuzutech/kroki-excalidraw
short-description: Companion server for Kroki that provides Excalidraw
readme-filepath: ./DOCKERHUB-COMPANION.md

- name: Docker Hub Description - mermaid
uses: peter-evans/[email protected]
with:
username: ${{ secrets.DOCKER_USERNAME }}
password: ${{ secrets.DOCKER_PASSWORD }}
repository: yuzutech/kroki-mermaid
short-description: Companion server for Kroki that provides Mermaid
readme-filepath: ./DOCKERHUB-COMPANION.md

- name: Docker Hub Description - blockdiag
uses: peter-evans/[email protected]
with:
username: ${{ secrets.DOCKER_USERNAME }}
password: ${{ secrets.DOCKER_PASSWORD }}
repository: yuzutech/kroki-blockdiag
short-description: Companion server for Kroki that provides BlockDiag, SeqDiag, ActDiag, NwDiag, PacketDiag and RackDiag
readme-filepath: ./DOCKERHUB-COMPANION.md
21 changes: 21 additions & 0 deletions DOCKERHUB-COMPANION.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
# Kroki Companion Server

Provides additional diagram libraries to [yuzutech/kroki](https://hub.docker.com/r/yuzutech/kroki).

Read the [Kroki installation](https://docs.kroki.io/kroki/setup/install/#_images) to learn how to start Kroki companion containers.

## 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)

To learn more about Kroki, read the [documentation](https://docs.kroki.io/).

## Versioning

We use [SemVer](https://semver.org/) for versioning.

## License

This project is licensed under the MIT License.