feat: added nightly github action. updated docs

2025-02-21 16:30:48 -05:00
parent 1560d1e18c
commit 92a84af454
2 changed files with 87 additions and 0 deletions
@@ -30,6 +30,32 @@ docker run -d -p 8080:8080 --restart always --name Meshtastic-Web ghcr.io/meshta
 podman run -d -p 8080:8080 --restart always --name Meshtastic-Web ghcr.io/meshtastic/web
 ```

+## Nightly releases 
+
+Our nightly releases provide the latest development builds with cutting-edge features and fixes. These builds are automatically generated from the latest main branch every night and are available for testing and early adoption.
+
+```bash
+# With Docker
+docker run -d -p 8080:8080 --restart always --name Meshtastic-Web ghcr.io/meshtastic/web:nightly
+#With Podman
+podman run -d -p 8080:8080 --restart always --name Meshtastic-Web ghcr.io/meshtastic/web:nightly
+```
+
+[!WARNING] 
+ - Nightly builds represent the latest development state and may contain breaking changes
+ - These builds undergo automated testing but may be less stable than tagged release versions
+ - Not recommended for production environments unless you are actively testing new features
+ - No guarantee of backward compatibility between nightly builds
+
+### Version Information
+Each nightly build is tagged with:
+
+- The nightly tag for the latest build
+- A specific SHA for build reproducibility
+
+### Feedback
+If you encounter any issues with nightly builds, please report them in our [issues tracker](https://github.com/danditomaso/meshtastic-web/issues). Your feedback helps improve the stability of future releases
+
 ## Development & Building
 You'll need to download the package manager used with this repo. You can install it by visiting [Bun.sh](https://bun.sh/) and following the installation instructions.