From de07b6ac6b6ca3d24aef56208b86cf464321242d Mon Sep 17 00:00:00 2001 From: Charuka Karunanayake Date: Tue, 28 May 2024 15:50:52 +0530 Subject: [PATCH 1/2] Add update policy text --- UpdatePolicy.md | 39 +++++++++++++++++++++++++++++++++++++++ 1 file changed, 39 insertions(+) create mode 100644 UpdatePolicy.md diff --git a/UpdatePolicy.md b/UpdatePolicy.md new file mode 100644 index 0000000..e4ccea3 --- /dev/null +++ b/UpdatePolicy.md @@ -0,0 +1,39 @@ +# Chroeo CLI Update Policy + +## Update Frequency +We plan to release updates for the CLI on a bi-weekly basis, additionally, we may release unscheduled updates to +address critical security vulnerabilities or introduce major new functionality + +## Notification Strategy +New updates will be announced through the following channels: +- **In-tool notifications**: A message will be displayed within the CLI upon launch if a new version is available +- **Release notes**: Detailed information about each update including bug fixes, new features and breaking changes, will be published on the public repository + +## Update Delivery Method +Updates will be delivered through the following methods, + +### Package Managers(Not Available at now): +If installed via package manager updates will be available through the standard update mechanism of the particular package manager + +### Installer Script: +Simply running the installer script will install the latest version of the CLI + +## Rollback policy +If you encounter any issues with a new update, you can downgrade to the previous version by using the following command + +``` +# mac OS and linux +curl -o- https://cli.choreo.dev/install.sh | bash -s + +# windows +$arg = ""; $script = iwr https://cli.choreo.dev/install.ps1 -useb; & ([scriptblock]::Create($script)) $arg +``` + +## Breaking Changes +Significant changes that may break existing workflows will be clearly documented in the update’s release notes. +We encourage users to review the release notes before installing an update to be aware of any potential issues + +## Versioning Scheme +We use a .. versioning scheme. Major releases introduce significant new features or breaking +changes. Minor releases address bugs and introduce minor improvements. Patch releases fix critical security +vulnerabilities From 57e8955c9fff683f0cfda158ff9b4db7383dd847 Mon Sep 17 00:00:00 2001 From: Charuka Karunanayake Date: Tue, 28 May 2024 15:53:42 +0530 Subject: [PATCH 2/2] Update readme --- README.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/README.md b/README.md index e43a61a..95b76ac 100644 --- a/README.md +++ b/README.md @@ -34,3 +34,7 @@ choreo list projects ```bash choreo describe ``` + +## Update Policy +Please refer to our [Update Policy document](./UpdatePolicy.md) for more information +