Kroki.jl

Running a dedicated Kroki instance in CI environments can help ensure more reliable builds, e.g. when building documentation with integrated diagrams, etc. There are multiple ways of achieving this, increasing in difficulty/maintenance burden.

The service management functions mentioned above are the most straightforward way to get a local version of Kroki running. Public GitHub Actions runners have all the necessary tools supporting these functions readily installed. Hence, a call to Kroki.Service.start! is all that is necessary to run a local Kroki service on GitHub Actions. For instance from the make.jl script typically used for documentation generation. Other CI environments, such as GitLab CI, Travis, private GitHub Actions runners, etc. may require separate installation of Docker and/or Docker Compose.

Alternatively, the Docker Compose definitions can be leveraged in combination with an action such as isbang/compose-action to launch the necessary services.

It is also possible to use functionality such as service containers. It is important to take into account such an approach will require duplication of much of the configuration readily provided by the solutions mentioned above. Refer to Kroki's documentation for more information on the necessary container images.

In the last two cases it is important to remember to correctly configure the endpoint for the package using Kroki.Service.setEndpoint!. In the first case this will be handled automatically, provided the services are started within the same Julia session as where the diagrams are rendered.