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

Add Update policy document #2

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
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
4 changes: 4 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,3 +34,7 @@ choreo list projects
```bash
choreo describe <project|component>
```

## Update Policy
Please refer to our [Update Policy document](./UpdatePolicy.md) for more information

39 changes: 39 additions & 0 deletions UpdatePolicy.md
Original file line number Diff line number Diff line change
@@ -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 <release tag>

# windows
$arg = "<release-tag>"; $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 <major>.<minor>.<patch> 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