From 52467d236a27dc9e81084c5a8b713b5bcaf3573e Mon Sep 17 00:00:00 2001 From: fabriciojs Date: Tue, 23 Jan 2024 23:00:40 -0300 Subject: [PATCH] upgrade guide --- docs/25-Upgrade-Guide/0-Upgrading-Kool.md | 20 ++++++++++++++++++++ 1 file changed, 20 insertions(+) create mode 100644 docs/25-Upgrade-Guide/0-Upgrading-Kool.md diff --git a/docs/25-Upgrade-Guide/0-Upgrading-Kool.md b/docs/25-Upgrade-Guide/0-Upgrading-Kool.md new file mode 100644 index 00000000..9ea63574 --- /dev/null +++ b/docs/25-Upgrade-Guide/0-Upgrading-Kool.md @@ -0,0 +1,20 @@ +# Upgrade Guide + +## 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. + +### Changes to `kool.deploy.yml`: Now `kool.cloud.yml` + +It is recommended to rename your configuration file for **Kool.dev Cloud** from `kool.deploy.yml` to `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 `services..build` + +Version 3.x introduces two significant changes: + +- The YAML syntax for `services..build` in the `kool.cloud.yml` file must now align with the official Docker Compose reference for the `service..build` entry. +- 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 `docker build` command).