From patchwork Fri May 5 17:56:29 2023 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 8bit X-Patchwork-Submitter: Sai.Sathujoda@toshiba-tsip.com X-Patchwork-Id: 13232950 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org Received: from aws-us-west-2-korg-lkml-1.web.codeaurora.org (localhost.localdomain [127.0.0.1]) by smtp.lore.kernel.org (Postfix) with ESMTP id 72568C77B7C for ; Fri, 5 May 2023 17:56:50 +0000 (UTC) Received: from mo-csw.securemx.jp (mo-csw.securemx.jp [210.130.202.153]) by mx.groups.io with SMTP id smtpd.web11.1332.1683309399570180211 for ; Fri, 05 May 2023 10:56:40 -0700 Authentication-Results: mx.groups.io; dkim=missing; spf=pass (domain: toshiba-tsip.com, ip: 210.130.202.153, mailfrom: sai.sathujoda@toshiba-tsip.com) Received: by mo-csw.securemx.jp (mx-mo-csw1514) id 345HuZJU031189; Sat, 6 May 2023 02:56:36 +0900 X-Iguazu-Qid: 34trEg1Q7ybgMcsW6S X-Iguazu-QSIG: v=2; s=0; t=1683309395; q=34trEg1Q7ybgMcsW6S; m=T34iS25hv/X3PFtR52I/+XW5rTTL+lAyYGSLEpqfE+w= Received: from imx2-a.toshiba.co.jp (imx2-a.toshiba.co.jp [106.186.93.35]) by relay.securemx.jp (mx-mr1512) id 345HuYhB031717 (version=TLSv1.2 cipher=AES128-GCM-SHA256 bits=128 verify=NOT); Sat, 6 May 2023 02:56:35 +0900 From: Sai.Sathujoda@toshiba-tsip.com To: cip-dev@lists.cip-project.org, jan.kiszka@siemens.com Cc: Sai , dinesh.kumar@toshiba-tsip.com, kazuhiro3.hayashi@toshiba.co.jp Subject: [isar-cip-core] README_cip-core-version-release-policy.md : To define the versioning and release policy Date: Fri, 5 May 2023 23:26:29 +0530 X-TSB-HOP2: ON Message-Id: <20230505175629.4635-1-Sai.Sathujoda@toshiba-tsip.com> X-Mailer: git-send-email 2.20.1 MIME-Version: 1.0 X-OriginalArrivalTime: 05 May 2023 17:56:31.0613 (UTC) FILETIME=[EC95FAD0:01D97F7A] List-Id: X-Webhook-Received: from li982-79.members.linode.com [45.33.32.79] by aws-us-west-2-korg-lkml-1.web.codeaurora.org with HTTPS for ; Fri, 05 May 2023 17:56:50 -0000 X-Groupsio-URL: https://lists.cip-project.org/g/cip-dev/message/11412 From: Sai This document explains the versioning style used for isar-cip-core metadata releases, frequency of the releases and their policies. Signed-off-by: Sai --- doc/README_cip-core-version-release-policy.md | 42 +++++++++++++++++++ 1 file changed, 42 insertions(+) create mode 100644 doc/README_cip-core-version-release-policy.md diff --git a/doc/README_cip-core-version-release-policy.md b/doc/README_cip-core-version-release-policy.md new file mode 100644 index 0000000..14cd839 --- /dev/null +++ b/doc/README_cip-core-version-release-policy.md @@ -0,0 +1,42 @@ +# CIP metadata versioning and Release policy + +## Table of contents +1. [Objective](#objective) +2. [Versioning system](#versioningsystem) +3. [Release policy](#releasepolicy) + + ***** +
+ +## Revision History +| Revision No | Date | Change description | Author | Reviewed by | +|-------------|------------|---------------------------------------------------------------|--------------|-------------------------------------------| +| 001 | 2023-05-04 | Draft document for CIP versioning and release policy | Sai Ashrith | | + +**** +
+ +## Objective + +The primary objective is to document the release process, it’s frequency and version changing for isar-cip-core metadata. This metadata can be used by CIP users to create various flavors of images like **security image, testing image, partition-encrypted image** etc. in architectures like **x86_64, arm64, armhf**. + +## Versioning system + +The isar-cip-core metadata follows semantic versioning system i.e **x.y.z** format which is explained below: + +1. **z** is incremented only when critical bugs are fixed. + * For example, if the latest release version is **2.2.5**, then the upcoming release version after fixing some critical bugs will be **2.2.6**. + +2. **y** is incremented for each Debian point release or in case of isar-cip-core regular release. + * Let us assume that the latest release version is **2.1.1**, then the upcoming regular release version will be **2.2.1**. + +3. **x** is incremented when significant changes are done other than **y** and **z**. + * In cases where recipes are broken fundamentally, or support for an older Debian version is dropped then the value of x is incremented by 1. + * Let us assume that the latest release version is **1.0.1**. If changes similar to the one mentioned above are done, then the next release will be **2.0**. When **x** is incremented, **y** & **z** are reset to 0. + +## Release policy + +An approximate time gap of 3 months is taken between consecutive regular releases. During every release, CIP-Core plans to give out recipes (isar-cip-core metadata) using which the user can build the flavor of their choice. The images built after locking the package feeds to a specific snapshot date will be bit-identically reproducible. + +All the releases can be found [here](https://gitlab.com/cip-project/cip-core/isar-cip-core/-/tags). +