Skip to main content
Version: kirkstone_1-06-00

Release Procedure

Introduction​

Clea OS is distributed both in the form of BSP/Yocto source code and in the form of compiled images ready to be flashed into the device by the end user. The objective of the following page is to describe:

  • How tagging is done on the source code composing Clea OS.
  • How an Clea OS release is created.
  • What information and software download links can be found within each Clea OS release.

Manifest Structure​

Clea OS is a Yocto project developed and maintained by SECO developers. The classic source code structure for a Yocto project involves the presence of a Manifest repository that collects, tipically in the form of .xml files, the list of repositories that make up the Yocto source, each associated with a specific revision (commit SHA or tag). An example is the seco-imx.xml file from the Clea OS Manifest repository:

<?xml version="1.0" encoding="UTF-8"?>
<manifest>

    <remote name="seco-layer-imx"       alias="origin"   fetch="https://git.seco.com/clea-os/layers/seco" />
    <remote name="seco-external-imx"    alias="origin"   fetch="https://git.seco.com/clea-os/layers/external" />
    <remote name="freescale-community"  alias="origin"   fetch="https://github.com/Freescale" />

    <project name="meta-seco-imx"             revision="9ddcbf7000a8f00e06959538c9dfe2155655542f" path="layers/meta-seco-imx"         remote="seco-layer-imx" />
    <project name="meta-freescale.git"        revision="ddc8107bf33f61cbc7ea71802f492f5d8e297fad" path="layers/meta-freescale"        remote="freescale-community" />
    <project name="meta-freescale-distro.git" revision="d5bbb487b2816dfc74984a78b67f7361ce404253" path="layers/meta-freescale-distro" remote="freescale-community" />

</manifest>

In particular, the revisions of the repositories composing the Clea OS project are identified by the SHA of the commits inside the Manifest repository.
Whenever a change is integrated, via a Merge Request (MR from now on), into one of the repositories that make up Clea OS, the revision of that repository is updated within Manifest repository, which thus provides an up-to-date ‘snapshot’ of the project status.

Release on Manifest Tag​

Given the Manifest structure briefly described in the previous section, the release of each new version of Clea OS is defined starting from a tag assigned to a specific commit SHA on the Manifest repository. In particular, whenever a tag occurs, GitLab CI/CD pipelines take charge of running the Clea OS builds for that tag and to make software artifacts accessible to the public.
In order to make clea-os releases easily usable from the outside, once the automation tasks associated with the tag are completed, a new GitLab Release associated with that tag is created and always accessible within the Manifest repository at the following link.

What does an Clea OS release consist of?​

Within each release page of the Clea OS project the user can track down, in addition to links to download the software, various information of general interest. Specifically, the standard sections within each release together with the information they are composed of are detailed in the sections below.

Added Features​

This introductory section of the release page summarizes the major features introduced by the Clea OS release. Typically, the features are separated for the two distros: Embedded and Things. An example of the information contained within it is presented in the image below.

alt text

Bug Fixes​

This section of the release page contains the list of the major fixes introduced by the Clea OS release. Typically the fixes relate to the BSP (U-Boot/Kernel) and support to peripherals. An example of the information contained within it is presented in the image below.

alt text

Hardware Support​

This section of the release page contains the list of boards for which support is guaranteed for that particular release of Clea OS. This list also provides access to the board software documentation, tipically available at this link.

alt text

This section of the release page contains the list of software artifacts that can be downloaded for that particular release of Clea OS, separately for each supported device. The description of this section is detailed in the Download Links page.

Changelog​

This section of the release page contains the link to download the changelog associated with all Clea OS releases. The changelog is automatically compiled by the CI/CD automation using GitLab API and contains within it the list of MRs (with their respective URLs) that have been merged for each repository that makes up the project. The MRs are grouped for each tag, so as to provide an accurate list of changes occurred to the source code in between tags/releases.

alt text

Known Issues​

This section of the release page contains a list of known issues associated with that release of Clea OS. Each version of Clea OS is tested before being released toward the public and some bugs may remain open in a model with releases tipically cadenced every 1/2 months. Automation collects all Jira bugs associated with the Clea OS project that have not yet been resolved and collects them to make them available to end users so that any anomalies in the operation of the OS are known.

alt text