Skip to content

Commit

Permalink
Update HWReleaseProcess.md
Browse files Browse the repository at this point in the history
  • Loading branch information
fdamato authored Jul 14, 2023
1 parent f06effe commit 1a2ec74
Showing 1 changed file with 6 additions and 6 deletions.
12 changes: 6 additions & 6 deletions HWReleaseProcess.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

1. When the **HW Release Workflow** is triggered, the **RTL Submodule Pointer Update** flow is called
2. The **nightly-verilator** smoke test regression test will be executed against the HEAD of the **main** branch
- If the the test passes a **release collateral** archive will be generated and pushed as a Github Artifact
- If the test passes a **release collateral** archive will be generated and pushed as a Github Artifact
- Repo tag will be added as well in the form "release_v#yyyy#mm#dd_#n"

## RTL Submodule Pointer Update
Expand All @@ -14,12 +14,12 @@
2. A new commit will update the RTL submodule pointer to point to the HEAD of the main branch, and update the registers RDL
3. A new **nightly release** branch will be created from the HEAD of the **main** branch in the **caliptra-sw** repo
- Naming of the branch will indicate it is a nightly release and will have a target point release date (ci_rtl_#yyyy#mm#dd_#n)
4. The branch wil trigger all the CI tests required to submit a PR
5. Upon succesfully completion of the CI tests, the branch will be merged and deleted
4. The branch will trigger all the CI tests required to submit a PR
5. Upon succesful completion of the CI tests, the branch will be merged and deleted

## Major Releases

1. The RTL team will consume the **release collateral** generated by the **Nightly Workflow** and verfies in the DV environment. The verification should include RTL synthesis using the chosen tool from the Caliptra WG.
1. The RTL team will consume the **release collateral** generated by the **Nightly Workflow** and verify it in the DV environment. The verification should include RTL synthesis using the chosen tool from the Caliptra WG.
2. Upon success of the DV verification a new release will be made on the **caliptra** repo
- A ZIP file containing the release collateral will be included as part of the release.
4. The **caliptra-rtl** and **caliptra-sw** repos will be tagged with a **release** version tag.
Expand All @@ -31,9 +31,9 @@
2. The next **nightly release** workflow will generate the release
2. Failure in RTL Repo
1. Manual intervention required. Create a new issue into the RTL Repo. Nightly releases are gated to become major until a fix is merged to main.
2. While HW fix requires longer time to be submitted, it is acceptable to temporarly diverging from the main branch.
2. While HW fix requires longer time to be submitted, it is acceptable to temporarily diverge from the main branch.
- A dev branch will be created from the tip of the RTL main branch, and WA fixes will be applied as individual commits
- The RTL Sumbodule pointer in the **caliptra sw** repo will maunally be updated to point to the dev branch.
- The RTL Sumbodule pointer in the **caliptra sw** repo will manually be updated to point to the dev branch.
- The nightly release workflow will generate all individual patches as part of the collateral archive and list them in the release notes.
4. Once the issue is fixed, the RTL dev branch will be deleted and the RTL submodule pointer will be repositioned to the HEAD of the RTL main branch.

Expand Down

0 comments on commit 1a2ec74

Please sign in to comment.