Skip to content

Commit e4d9a70

Browse files
Add installation steps, higher level documentation for previously added scripts
1 parent bc6dcad commit e4d9a70

4 files changed

Lines changed: 392 additions & 128 deletions

File tree

NEW_RELEASE.md

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,13 +27,20 @@ This project follows [Semantic Versioning](https://semver.org/). Here are some e
2727
* `0.3.0-alpha.0` is the first alpha release of the `0.3` feature release.
2828

2929
## Making a release
30+
- [ ] Decide what type of release you are making - Full or Delta
3031
- [ ] Ensure the PR(s) with your features & fixes are merged into `main`.
3132
- [ ] Update the API by running `scripts/create_spec` script.
3233
- [ ] Create & merge a branch/PR off `main` to bump the version in the CHANGELOG and also using `poetry version ${VERSION}`
3334
- [ ] Checkout main & create a detached HEAD: `git checkout main; git pull; git checkout --detach`
3435
- [ ] 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.
3536
- [ ] 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
3744
- [ ] Use the AmpliPi updater to update to the release
3845
- [ ] Test it again! If it needs changes, pull request your bugfixes against `main` and stamp a new release 😎
3946
- [ ] Inform Production of the new software so they keep backstock units updated prior to shipment

0 commit comments

Comments
 (0)