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.

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

Update companion images description on Docker Hub #753

Merged
merged 7 commits into from
May 22, 2021
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
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
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/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
lind marked this conversation as resolved.
Show resolved Hide resolved
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
lind marked this conversation as resolved.
Show resolved Hide resolved
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
lind marked this conversation as resolved.
Show resolved Hide resolved
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
lind marked this conversation as resolved.
Show resolved Hide resolved
readme-filepath: ./DOCKERHUB-COMPANION.md
21 changes: 21 additions & 0 deletions DOCKERHUB-COMPANION.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
# Kroki Companion Image
lind marked this conversation as resolved.
Show resolved Hide resolved

Image to use together with this server: [yuzutech/kroki](https://hub.docker.com/r/yuzutech/kroki)
lind marked this conversation as resolved.
Show resolved Hide resolved

GitHub repository: [kroki](https://github.com/yuzutech/kroki)
lind marked this conversation as resolved.
Show resolved Hide resolved

## Usage

Use this images with:
* [Docker-compose](https://docs.kroki.io/kroki/setup/install/#_using_docker_compose)
lind marked this conversation as resolved.
Show resolved Hide resolved
* [Kubernetes](https://docs.kroki.io/kroki/setup/install/#_using_kubernetes)

For installation and configuration see [Kroki docs](https://docs.kroki.io/)
lind marked this conversation as resolved.
Show resolved Hide resolved

## Versioning

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

## License

This project is licensed under the MIT License.