You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: NEW_RELEASE.md
+8-1Lines changed: 8 additions & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -27,13 +27,20 @@ This project follows [Semantic Versioning](https://semver.org/). Here are some e
27
27
*`0.3.0-alpha.0` is the first alpha release of the `0.3` feature release.
28
28
29
29
## Making a release
30
+
-[ ] Decide what type of release you are making - Full or Delta
30
31
-[ ] Ensure the PR(s) with your features & fixes are merged into `main`.
31
32
-[ ] Update the API by running `scripts/create_spec` script.
32
33
-[ ] Create & merge a branch/PR off `main` to bump the version in the CHANGELOG and also using `poetry version ${VERSION}`
33
34
-[ ] Checkout main & create a detached HEAD: `git checkout main; git pull; git checkout --detach`
34
35
-[ ] CD into `web`, Run `echo "VITE_BACKEND_VERSION=$(poetry version -s)" > .env; npm run build; git add -f web/dist; git commit -m "Build web app for release"`. This will encode the version number into the frontend, build it, and add the build to git for release.
35
36
-[ ] Tag the changes so we can make a release on GitHub: `git tag -as ${VERSION} -m '' && git push origin ${VERSION}`
36
-
-[ ] Make a release using the GitHub interface
37
+
- Based on which release version you're making:
38
+
- Full Release (larger update with linux changes):
39
+
-[ ] Run the golden script and deploy to the fresh partitions, then create an image of this fresh boot partition (and boot, if you changed things there)
40
+
-[ ] Host image(s) at (OUR FILESERVER'S BASE URL)/${VERSION}/, copy each image's real download link into manifest.json's matching `root`/`boot``url` field by hand
41
+
- Delta Release (Smaller, only touches AmpliPi code rather than wider system state):
42
+
-[ ] Run `scripts/make_delta_manifest ${VERSION} ${MIN_BASE_VERSION}` to generate manifest.json (git_ref always matches `${VERSION}`) - no images, so no fileserver upload needed
43
+
-[ ] Make a release using the GitHub interface, attach manifest.json
37
44
-[ ] Use the AmpliPi updater to update to the release
38
45
-[ ] Test it again! If it needs changes, pull request your bugfixes against `main` and stamp a new release 😎
39
46
-[ ] Inform Production of the new software so they keep backstock units updated prior to shipment
0 commit comments