| Paul Beesley | fc9ee36 | 2019-03-07 15:47:15 +0000 | [diff] [blame] | 1 | Release Processes |
| 2 | ================= |
| Joel Hutton | 9e60563 | 2019-02-25 15:18:56 +0000 | [diff] [blame] | 3 | |
| Joel Hutton | 9e60563 | 2019-02-25 15:18:56 +0000 | [diff] [blame] | 4 | Project Release Cadence |
| 5 | ----------------------- |
| 6 | |
| 7 | The project currently aims to do a release once every 6 months which will be |
| 8 | tagged on the master branch. There will be a code freeze (stop merging |
| 9 | non-essential PRs) up to 4 weeks prior to the target release date. The release |
| 10 | candidates will start appearing after this and only bug fixes or updates |
| 11 | required for the release will be merged. The maintainers are free to use their |
| 12 | judgement on what PRs are essential for the release. A release branch may be |
| 13 | created after code freeze if there are significant PRs that need merging onto |
| 14 | the integration branch during the merge window. |
| 15 | |
| 16 | The release testing will be performed on release candidates and depending on |
| 17 | issues found, additional release candidates may be created to fix the issues. |
| 18 | |
| 19 | :: |
| 20 | |
| 21 | |<----------6 months---------->| |
| 22 | |<---4 weeks--->| |<---4 weeks--->| |
| 23 | +-----------------------------------------------------------> time |
| 24 | | | | | |
| 25 | code freeze ver w.x code freeze ver y.z |
| 26 | |
| 27 | |
| 28 | Upcoming Releases |
| 29 | ~~~~~~~~~~~~~~~~~ |
| 30 | |
| 31 | These are the estimated dates for the upcoming release. These may change |
| 32 | depending on project requirement and partner feedback. |
| 33 | |
| 34 | +-----------------+---------------------------+------------------------------+ |
| 35 | | Release Version | Target Date | Expected Code Freeze | |
| 36 | +=================+===========================+==============================+ |
| 37 | | v2.0 | 1st week of Oct '18 | 1st week of Sep '18 | |
| 38 | +-----------------+---------------------------+------------------------------+ |
| 39 | | v2.1 | 5th week of Mar '19 | 1st week of Mar '19 | |
| 40 | +-----------------+---------------------------+------------------------------+ |
| 41 | |
| 42 | Removal of Deprecated Interfaces |
| 43 | -------------------------------- |
| 44 | |
| Paul Beesley | f864067 | 2019-04-12 14:19:42 +0100 | [diff] [blame] | 45 | As mentioned in the :ref:`Platform Compatibility Policy`, this is a live |
| 46 | document cataloging all the deprecated interfaces in TF-A project and the |
| 47 | Release version after which it will be removed. |
| Joel Hutton | 9e60563 | 2019-02-25 15:18:56 +0000 | [diff] [blame] | 48 | |
| 49 | +--------------------------------+-------------+---------+---------------------------------------------------------+ |
| 50 | | Interface | Deprecation | Removed | Comments | |
| 51 | | | Date | after | | |
| 52 | | | | Release | | |
| 53 | +================================+=============+=========+=========================================================+ |
| 54 | | Legacy Console API | Jan '18 | v2.1 | Deprecated in favour of ``MULTI_CONSOLE_API`` | |
| 55 | +--------------------------------+-------------+---------+---------------------------------------------------------+ |
| 56 | | Weak default | Oct '18 | v2.1 | The default implementations are defined in | |
| Paul Beesley | f864067 | 2019-04-12 14:19:42 +0100 | [diff] [blame] | 57 | | ``plat_crash_console_*`` | | | ``crash_console_helpers.S``. The platforms have to | |
| Joel Hutton | 9e60563 | 2019-02-25 15:18:56 +0000 | [diff] [blame] | 58 | | APIs | | | define ``plat_crash_console_*``. | |
| 59 | +--------------------------------+-------------+---------+---------------------------------------------------------+ |
| 60 | | ``finish_console_register`` | Oct '18 | v2.1 | The old version of the macro is deprecated. See commit | |
| 61 | | macro in | | | cc5859c_ for more details. | |
| 62 | | ``MULTI_CONSOLE_API`` | | | | |
| 63 | +--------------------------------+-------------+---------+---------------------------------------------------------+ |
| 64 | | Types ``tzc_action_t`` and | Oct '18 | v2.1 | Using logical operations such as OR in enumerations | |
| 65 | | ``tzc_region_attributes_t`` | | | goes against the MISRA guidelines. | |
| 66 | +--------------------------------+-------------+---------+---------------------------------------------------------+ |
| 67 | | Macro ``EL_IMPLEMENTED()`` | Oct '18 | v2.1 | Deprecated in favour of ``el_implemented()``. | |
| 68 | +--------------------------------+-------------+---------+---------------------------------------------------------+ |
| 69 | | ``get_afflvl_shift()``, | Dec '18 | v2.1 | Removed. | |
| 70 | | ``mpidr_mask_lower_afflvls()``,| | | | |
| 71 | | and ``eret()``. | | | | |
| 72 | +--------------------------------+-------------+---------+---------------------------------------------------------+ |
| 73 | | Extra include paths in the | Jan '18 | v2.1 | Now it is needed to use the full path of the common | |
| 74 | | Makefile in ``INCLUDES``. | | | header files. More information in commit 09d40e0e0828_. | |
| 75 | +--------------------------------+-------------+---------+---------------------------------------------------------+ |
| 76 | |
| Paul Beesley | f864067 | 2019-04-12 14:19:42 +0100 | [diff] [blame] | 77 | -------------- |
| 78 | |
| Joel Hutton | 0f79fb1 | 2019-02-26 16:23:54 +0000 | [diff] [blame] | 79 | *Copyright (c) 2018-2019, Arm Limited and Contributors. All rights reserved.* |
| Joel Hutton | 9e60563 | 2019-02-25 15:18:56 +0000 | [diff] [blame] | 80 | |
| Joel Hutton | 0f79fb1 | 2019-02-26 16:23:54 +0000 | [diff] [blame] | 81 | .. _cc5859c: https://git.trustedfirmware.org/TF-A/trusted-firmware-a.git/commit/?id=cc5859ca19ff546c35eb0331000dae090b6eabcf |
| 82 | .. _09d40e0e0828: https://git.trustedfirmware.org/TF-A/trusted-firmware-a.git/commit/?id=09d40e0e08283a249e7dce0e106c07c5141f9b7e |