aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorSoby Mathew <soby.mathew@arm.com>2020-06-17 13:58:51 +0100
committerAnton Komlev <Anton.Komlev@arm.com>2020-06-24 09:24:41 +0000
commit6325be52ae577738612892cbe612a22ad98e13aa (patch)
tree7ef4fb7dc66ed45bcbd8796205c254150b61f154
parent6710c8219d16e346ecfeef4f3919493d9d0bdfa9 (diff)
downloadtrusted-firmware-m-6325be52ae577738612892cbe612a22ad98e13aa.tar.gz
docs: Add release cadence information
This patch adds premiliminary information about release cadence to be followed by the project. Signed-off-by: Soby Mathew <soby.mathew@arm.com> Change-Id: If695862e5e428538595e3c9f96f815089b7447bf
-rw-r--r--docs/contributing/release_process.rst30
-rw-r--r--docs/introduction/readme.rst9
2 files changed, 36 insertions, 3 deletions
diff --git a/docs/contributing/release_process.rst b/docs/contributing/release_process.rst
new file mode 100644
index 000000000..b47913c87
--- /dev/null
+++ b/docs/contributing/release_process.rst
@@ -0,0 +1,30 @@
+Release Cadence and Process
+===========================
+
+Project Release Cadence
+-----------------------
+
+The project currently aims to do a release once every 4 months which will be
+tagged on the master branch. There will be a code freeze (stop merging
+non-essential changes) up to 3 weeks prior to the target release date. The
+release candidates will start appearing after this and only bug fixes or
+updates required for the release will be merged. The maintainers are free
+to use their judgement on what changes are essential for the release.
+
+The release testing will be performed on release candidates and depending on
+issues found, additional release candidates may be created to fix the issues.
+
+::
+
+ |<------------4 months----------->|
+ |<--upto 3 weeks-->| |<--upto 3 weeks-->|
+ +----------------------------------------------------- ----------> time
+ | | | |
+ code freeze ver w.x code freeze ver y.z
+
+Although this document specifies the release cadence, this does not preclude
+an adhoc release for specific project requirements.
+
+--------------
+
+*Copyright (c) 2020, Arm Limited. All rights reserved.*
diff --git a/docs/introduction/readme.rst b/docs/introduction/readme.rst
index 610bddf68..bc30e411b 100644
--- a/docs/introduction/readme.rst
+++ b/docs/introduction/readme.rst
@@ -36,9 +36,12 @@ folders. The original license text is included in those source files.
specific subfolder named ``ext`` so that it can be isolated if required.
The 'ext' folder can be seen in the folders above mentioned.
-#############
-Release Notes
-#############
+#########################
+Release Notes and Process
+#########################
+The :doc:`Release Cadence and Process </docs/contributing/release_process>` provides
+release cadence and process information.
+
The :doc:`Change Log & Release Notes </docs/reference/changelog>` provides details of
major features of the release and platforms supported.