Replaced EastMesh to MeshCoreTel across all the docs
This commit is contained in:
+11
-11
@@ -12,20 +12,20 @@ Example:
|
||||
|
||||
This value becomes the base `FIRMWARE_VERSION` used by the release workflows.
|
||||
|
||||
## EastMesh Release Tags
|
||||
## MeshCoreTel-firmware Release Tags
|
||||
|
||||
Push one or more of the following tag formats to trigger the matching firmware release workflow:
|
||||
|
||||
- `companion-wifi-v1.2.3`
|
||||
- `repeater-mqtt-eastmesh-v1.0.1`
|
||||
- `repeater-mqtt-meshcoretel-v1.0.1`
|
||||
|
||||
Use the upstream MeshCore version in `companion-wifi-v1.2.3`.
|
||||
Use the EastMesh release version in `repeater-mqtt-eastmesh-v1.0.1`.
|
||||
Use the MeshCoreTel-firmware release version in `repeater-mqtt-meshcoretel-v1.0.1`.
|
||||
|
||||
Each tag triggers a separate workflow:
|
||||
|
||||
- `companion-wifi-v*` builds companion WiFi firmware
|
||||
- `repeater-mqtt-eastmesh-*` builds repeater MQTT firmware
|
||||
- `repeater-mqtt-meshcoretel-*` builds repeater MQTT firmware
|
||||
|
||||
You can push one, or more tags on the same commit, and they will all build separately.
|
||||
|
||||
@@ -35,18 +35,18 @@ During the GitHub Actions build:
|
||||
|
||||
- `companion-wifi` uses the version in the tag as `FIRMWARE_VERSION`
|
||||
- `repeater-mqtt` uses `OFFICIAL_MESHCORE_VERSION` as `FIRMWARE_VERSION`
|
||||
- `repeater-mqtt` uses the EastMesh version from the tag as `EASTMESH_VERSION`
|
||||
- `repeater-mqtt` uses the MeshCoreTel-firmware version from the tag as `MESHCORETEL_VERSION`
|
||||
|
||||
The resulting version string depends on the workflow:
|
||||
|
||||
- `companion-wifi`: `v1.2.3-<commit>`
|
||||
- `repeater-mqtt`: `v1.2.3-eastmesh-v1.0.1-<commit>`
|
||||
- `repeater-mqtt`: `v1.2.3-vbart-meshcoretel-v1.0.1-<commit>`
|
||||
|
||||
Example:
|
||||
|
||||
- tag: `repeater-mqtt-eastmesh-v1.0.1`
|
||||
- tag: `repeater-mqtt-meshcoretel-v1.0.1`
|
||||
- repo variable: `OFFICIAL_MESHCORE_VERSION=v1.2.3`
|
||||
- resulting build version: `v1.2.3-eastmesh-v1.0.1-abcdef`
|
||||
- resulting build version: `v1.2.3-meshcoretel-v1.0.1-abcdef`
|
||||
|
||||
## Typical Release Flow
|
||||
|
||||
@@ -65,11 +65,11 @@ Example:
|
||||
|
||||
```bash
|
||||
git tag companion-wifi-v1.2.3
|
||||
git tag repeater-mqtt-eastmesh-v1.0.1
|
||||
git push origin companion-wifi-v1.2.3 repeater-mqtt-eastmesh-v1.0.1
|
||||
git tag repeater-mqtt-meshcoretel-v1.0.1
|
||||
git push origin companion-wifi-v1.2.3 repeater-mqtt-meshcoretel-v1.0.1
|
||||
```
|
||||
|
||||
## Supported Tags
|
||||
|
||||
- `companion-wifi-v1.2.3`
|
||||
- `repeater-mqtt-eastmesh-v1.0.1`
|
||||
- `repeater-mqtt-meshcoretel-v1.0.1`
|
||||
|
||||
Reference in New Issue
Block a user