Donate to e Foundation | Murena handsets with /e/OS | Own a part of Murena! Learn more

Commit c5cdf16e authored by Ronak Patel's avatar Ronak Patel Committed by Akhil
Browse files

Resolve "Update README.md about builds structure"

parent db49d36a
Loading
Loading
Loading
Loading
+15 −0
Original line number Diff line number Diff line
@@ -43,6 +43,21 @@ then finally visit http://localhost/ to see the REST Server up and running.
- Full builds should be uploaded into `builds/full` directory.
- Delta builds should be uploaded into `builds/delta` directory.

### Folder Structure for Builds

All the builds , props, md5sum and other files of a device and channel needs to be in common folder. You must follow below folder structure. The same folder name must be used in API.

```shell
builds/full/<CHANNEL>/<DEVICE>
```

For Example, All builds and other files of star2lte for stable channel will be in  `/builds/full/stable/star2lte`

### Device and Channel fields are now mandatory in API 

The fields `device` and `channel` are mandatory and `incremental` is an optional field in an API (which is used to get the builds).


## How to specify allowed migration paths

- You can specify migration rules (whether an upgrade from a version to a version is allowed or not) by creating a migration_paths.json file in your build directory