From bb8082d96609d55a37bc26297b6bcb364bc12297 Mon Sep 17 00:00:00 2001 From: liamcottle Date: Mon, 3 Mar 2025 18:08:00 +1300 Subject: [PATCH] add release docs --- RELEASE.md | 15 +++++++++++++++ 1 file changed, 15 insertions(+) create mode 100644 RELEASE.md diff --git a/RELEASE.md b/RELEASE.md new file mode 100644 index 00000000..a4a19495 --- /dev/null +++ b/RELEASE.md @@ -0,0 +1,15 @@ +# Releasing Firmware + +GitHub Actions is set up to automatically build and release firmware. + +It will automatically build firmware when one of the following tag formats are pushed. + +- `companion-v1.0.0` +- `repeater-v1.0.0` +- `room-server-v1.0.0` + +> NOTE: replace `v1.0.0` with the version you want to release as. + +- You can push one, or more tags on the same commit, and they will all build separately. +- Once the firmware has been built, a new (draft) GitHub Release will be created. +- You will need to update the release notes, and publish it.