| Gyorgy Szing | fa20890 | 2022-11-25 11:56:58 +0100 | [diff] [blame] | 1 | Releases |
| 2 | ======== |
| 3 | |
| 4 | The release is a well documented and identifiable "quality snapshot" of the products the project is developing. It helps |
| 5 | adopters by providing reference points and understanding differences between these. |
| 6 | |
| 7 | Due to the :ref:`Version Control` policy implemented, each commit on the "main" branch has a source code and runtime |
| 8 | quality level as a release. The release in addition to that ads extra documentation of changes in form of the |
| 9 | :ref:`Change Log & Release Notes` |
| 10 | |
| 11 | Cadence |
| 12 | ------- |
| 13 | |
| 14 | There is no fixed release cadence defined yet. |
| 15 | |
| 16 | Release procedure |
| 17 | ================= |
| 18 | |
| 19 | ``DR`` below stands for "Day of Release". |
| 20 | |
| 21 | .. list-table:: Release steps |
| 22 | :header-rows: 1 |
| 23 | |
| 24 | * - Time |
| 25 | - Task |
| 26 | * - ``DR``-3w |
| 27 | - |
| 28 | - Send notification to |TS_MAIL_LIST| about upcoming release. |
| 29 | - Release note update starts. |
| 30 | - Platform maintainers prepare for testing their platforms. |
| 31 | * - ``DR``-1w |
| 32 | - |
| 33 | - A release PR is created updating the release ID and release notes. |
| 34 | - "integration" branch is frozen and "main" branch is updated if needed. |
| 35 | - "main" branch is tagged with `_rc0` tag to mark start of release testing. |
| 36 | - Maintainers start release testing. |
| 37 | - Platform maintainers start release testing their platforms. |
| 38 | * - ``DR`` |
| 39 | - |
| 40 | - Release notes is finalized. |
| 41 | - Release PR gets merged. |
| 42 | - "main" branch is updated. |
| 43 | - "main" branch is tagged. |
| 44 | - Release announcement is sent to |TS_MAIL_LIST|. |
| 45 | |
| 46 | Errors discovered during testing will break the release process. Fixes need to be made and merged as usual, and release |
| 47 | testing to be restarted with including applying a new ``_rc<x>`` tag, where ``<x>`` is a monotonic counter. |
| 48 | |
| 49 | If fixing the encountered errors takes long, the release is either aborted and postponed, or the defects are captured in |
| 50 | the release notes under the "known issues" section. |
| 51 | |
| 52 | -------------- |
| 53 | |
| 54 | *Copyright (c) 2022, Arm Limited and Contributors. All rights reserved.* |
| 55 | |
| 56 | SPDX-License-Identifier: BSD-3-Clause |