1
0
mirror of https://github.com/esphome/home-assistant-addon.git synced 2024-12-19 16:17:40 +01:00

Add maintainer notes

This commit is contained in:
Otto Winter 2020-07-15 15:01:12 +02:00
parent f42eb03edc
commit 62877fccbb
No known key found for this signature in database
GPG Key ID: 48ED2DDB96D7682C

24
script/NOTES.md Normal file
View File

@ -0,0 +1,24 @@
# Maintainer notes
This repository is pulled by all Hassio installs and contains
the Hassio config for each type of install: latest, beta and dev.
- `latest` always points to the most recent full release.
- `beta` points to the most recent full release or beta release (whichever is newer). This is so that beta image users automatically get upgraded to the stable install once it gets released.
- `dev` is an image that Hassio builds itself and contains the latest ESPHome version straigt from dev branch.
The config.json files are all automatically written with the script in this directory and the `template/config.yaml` file.
To update one of the images: use
```bash
$ pip3 install -r script/requirements.txt
$ python3 script/generate.py [dev|beta|latest]
```
The `esphome-dev/rootfs` folder is shared with the `docker/rootfs` folder in the esphome repo.
This could be solved better, but currently `rsync` is used to copy the files over:
```bash
rsync -av ../esphome/docker/rootfs esphome-dev/
```