From 3042832dba319613766650d9b3baf985fed09cb9 Mon Sep 17 00:00:00 2001 From: Caleb Whitehead Date: Mon, 20 May 2024 14:47:46 -0700 Subject: [PATCH] Change some RTL steps to explanatory sub-bullets --- doc/HWReleaseProcess.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/doc/HWReleaseProcess.md b/doc/HWReleaseProcess.md index cacdfdc..e345137 100644 --- a/doc/HWReleaseProcess.md +++ b/doc/HWReleaseProcess.md @@ -20,10 +20,10 @@ ## Major Releases 1. Before finalizing an RTL release, the hardware team will follow the procedure described in [CaliptraReleaseChecklist.md](https://github.com/chipsalliance/caliptra-rtl/blob/cc37991e50f9213219d13f2e0d99b0ba5c7460e0/docs/CaliptraReleaseChecklist.md). -2. Upon finalizing all release checklist items, the hardware team will generate a release tag on the RTL **main** branch, following the naming convention `v.`. -3. When this is completed, the RTL team will create a new branch following the naming convention `patch_v.`. This branch will exactly match the contents of the major release tag. Any future fixes that must be applied as patches to this release version will be committed to the `patch_v.` branch. Branch **main** will continue to receive updated code for the subsequent planned release, and is not guaranteed to contain a valid release except as tagged. -4. The software team will follow the submodule update [steps](#RTL-Submodule-Pointer-Update) to revise the RTL submodule pointer to consume the code from branch `patch_v.` instead of from branch **main**. -4. The **caliptra-sw** repo will be tagged with a **release** version tag. As a result of the submodule flow, this release will contain a snapshot of the code from **caliptra-rtl** repo that has already been tagged with the release version. + - Upon finalizing all release checklist items, the hardware team will generate a release tag on the RTL **main** branch, following the naming convention `v.`. + - When this is completed, the RTL team will create a new branch following the naming convention `patch_v.`. This branch will exactly match the contents of the major release tag. Any future fixes that must be applied as patches to this release version will be committed to the `patch_v.` branch. Branch **main** will continue to receive updated code for the subsequent planned release, and is not guaranteed to contain a valid release except as tagged. +2. The software team will follow the submodule update [steps](#RTL-Submodule-Pointer-Update) to revise the RTL submodule pointer to consume the code from branch `patch_v.` instead of from branch **main**. +3. The **caliptra-sw** repo will be tagged with a **release** version tag. As a result of the submodule flow, this release will contain a snapshot of the code from **caliptra-rtl** repo that has already been tagged with the release version. ## Fail Case