Skip to content

Commit

Permalink
Change some RTL steps to explanatory sub-bullets
Browse files Browse the repository at this point in the history
  • Loading branch information
calebofearth committed May 20, 2024
1 parent 176de37 commit 3042832
Showing 1 changed file with 4 additions and 4 deletions.
8 changes: 4 additions & 4 deletions doc/HWReleaseProcess.md
Original file line number Diff line number Diff line change
Expand Up @@ -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<major>.<minor>`.
3. When this is completed, the RTL team will create a new branch following the naming convention `patch_v<major>.<minor>`. 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<major>.<minor>` 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<major>.<minor>` 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<major>.<minor>`.
- When this is completed, the RTL team will create a new branch following the naming convention `patch_v<major>.<minor>`. 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<major>.<minor>` 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<major>.<minor>` 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

Expand Down

0 comments on commit 3042832

Please sign in to comment.