Skip to content

Commit 42dc978

Browse files
Chris Friedtcfriedt
authored andcommitted
doc: release: add manual steps for creating a tt-firmware release
Document manual steps required to create a tt-firmware release from the automated release from tt-zephyr-platforms. In the future, it might be better to automate this process using GitHub actions, or simply sunset the old tt-firmware repository, and rename tt-zephyr-platforms to tt-firmware. Making firware releases in two locations seems a bit redundant. Signed-off-by: Chris Friedt <[email protected]>
1 parent 333bae4 commit 42dc978

File tree

1 file changed

+66
-10
lines changed

1 file changed

+66
-10
lines changed

doc/release/release-process.md

Lines changed: 66 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -94,23 +94,79 @@ Lastly, for final releases,
9494
9595
6. Find the generated
9696
[draft release](https://github.com/tenstorrent/tt-zephyr-platforms/releases), edit the release
97-
notes, and publish the release.
97+
notes, and publish the release. It is recommended to copy the contents of
98+
`doc/release/release-notes-1.2.3.md` into the release-notes area.
9899
99100
7. Announce the release via official Tenstorrent channels and provide a link to the
100101
GitHub release page.
101102
102103
### Publishing a Combined Firmware Bundle to `tt-firmware`
103104
104-
Find the `.fwbundle` file and combine it with closed-source firmware versions for older Tenstorrent
105-
products.
105+
Make a pull request to [tt-firmware](https://github.com/tenstorrent/tt-firmware) with the new
106+
combined firmware bundle and accompanying required changes.
107+
108+
As part of the pull request:
109+
110+
1. Clone the `tt-firmware` repository (if it has not already been cloned).
106111
107112
```shell
108-
scripts/tt_boot_fs.py fwbundle \
109-
-o fw_pack-MAJOR.MINOR.PATCH.0.fwbundle \
110-
-v "MAJOR.MINOR.PATCH.0"
111-
-c tt-zephyr-platforms-MAJOR.MINOR.PATCH.0.fwbundle \
112-
-c closed-frmware-pack-MAJOR.MINOR.PATCH.0.fwbundle
113+
if [ ! -d ~/tt-firmware ]; then
114+
git clone [email protected]:tenstorrent/tt-firmware.git ~/tt-firmware
115+
cd ~/tt-firmware
116+
fi
113117
```
114118

115-
Make a pull request to [tt-firmware](https://github.com/tenstorrent/tt-firmware) with the new
116-
combined firmware bundle.
119+
2. Create a branch to make modifications for the release.
120+
121+
```shell
122+
git checkout -b release-v1.2.3
123+
```
124+
125+
3. Download the `fw_pack-<version>.fwbundle` file in the associated `tt-zephyr-platforms`
126+
[release](https://github.com/tenstorrent/tt-zephyr-platforms/releases).
127+
128+
```shell
129+
wget https://github.com/tenstorrent/tt-zephyr-platforms/releases/download/v1.2.3/fw_pack-1.2.3.fwbundle
130+
```
131+
132+
4. Change the `latest.fwbundle` symbolic link to point to the new firmware bundle and remove the
133+
older version, staging the files for commit.
134+
135+
```shell
136+
git rm -f $(readlink latest.fwbundle) latest.fwbundle
137+
ln -sf fw_pack-1.2.3.fwbundle latest.fwbundle
138+
git add *.fwbundle
139+
```
140+
141+
5. Edit the `README.md` file following the existing structure. Update the "Available Firmware"
142+
and "Release Notes" sections, staging the file for commit.
143+
144+
```shell
145+
$EDITOR README.md
146+
git add README.md
147+
```
148+
149+
6. Make a signed commit (`git commit -s`) for the changes using the commit subject and body below.
150+
151+
```
152+
release: fw bundle v1.2.3
153+
154+
Release FW Bundle v1.2.3
155+
156+
Signed-off-by: Your Name <[email protected]>
157+
```
158+
159+
7. Create a pull request for the changes. After the PR has been merged, refresh the `main` branch,
160+
and tag the release with a signed commit.
161+
162+
```shell
163+
git checkout main
164+
git pull
165+
git tag -s -m "tt-firmware 1.2.3" v1.2.3
166+
git push --tags
167+
```
168+
169+
8. Create a new `tt-firmware`
170+
[release from the new tag](https://github.com/tenstorrent/tt-firmware/releases/new) by
171+
copying the contents of `doc/release/release-notes-1.2.3.md` into the release notes for
172+
the new `tt-firmware` release.

0 commit comments

Comments
 (0)