Note on Versioning
Kool adheres to Semantic Versioning (SemVer) and is committed to maintaining backward compatibility, minimizing the potential for disruptive changes and multi-step upgrades.
Upgrading to 3.x
The release of major version 3.x introduces a few breaking changes. Please review and adjust your projects accordingly.
It is recommended to rename your configuration file for Kool.dev Cloud from
kool.cloud.yml. Although the old naming convention remains functional, it has been deprecated and will be removed in future releases.
Building Images for Deployment with
Version 3.x introduces two significant changes:
- The YAML syntax for
kool.cloud.ymlconfiguration file must now align with the official Docker Compose reference for the
- Image building now occurs in your local environment—specifically, on the host where you execute
kool cloud deploy. Therefore, ensure that the environment from which you run this command has a properly configured Docker-image build engine (that means Kool to be able to run
There's a new version of our official installation GH action
kool-dev/action@v3 - that will always install the latest v3 series release.
The first and now legacy
kool-dev/action@v1 has been updated and froze to its past behavior of installing the latest version regardless of the major version mismatch. That is why
kool-dev/action@v1 will for now on always install the latest v2 series release - currently