How to build an /e/ ROM?
Definitions: Custom vs Unofficial vs Official
A custom build is a build that is using most of the /e/ source code to generate a new ROM. It can be modified in any manner by the developer, for any purpose.
An unofficial /e/ build is a build from the /e/ source code that is intended to generate the /e/ ROM for a new, not yet supported, device. It’s not been approved officially and is not included yet to the list of official /e/ ROMs. It can be published publicly, tagged as “unofficial”.
An official /e/ build is an unofficial build from the /e/ source code that has reached a sufficient level of quality and has been validated. It has been published publicly as an official build on /e/ websites.
Requirements for differents builds:
Custom builds: if the source code has been modified and if the ROM is redistributed, we have several requirements:
- any reference to /e/, including “/e/”, and our logo must be removed from the build
- the redistribution must not let people think that it is /e/. The name must be changed and possibly say that it’s been forked from /e/
- calls to our OTA server infrastructure should be removed
- Custom ROMs can be built on /e/ servers only for exceptional reasons (special development…).
Unofficial /e/ builds: source code can be modified only to reach full support on the target device. /e/ features, list of installed apps etc. shouldn’t be modified. Unofficial builds can be published on the /e/ website at a specific place with warnings and a list of what works/what doesn’t work. It doesn’t have nightly builds nor OTA updates.
Official /e/ builds : the level of quality must have reached our conditions. It must have an official maintainer. Official builds have nightly builds and can be updated OTA. Source code have to be hosted on our GitLab instance, or on trusted sources (LineageOS GitHub group, AOSP).
How to build?
WARNING : This process will only work on case-sensitive filesystems!
- Windows: will not work
- macOS: doesn’t work either for HPS+ filesystem - adfs not tried
- Linux: work on Ubuntu and CentOS
1. Install docker
If you have not already done so, install docker
2. Get our docker image
$ sudo docker pull registry.gitlab.e.foundation:5000/e/os/docker-lineage-cicd:community
3. Create directories
4. Start build
Run the following command. Don’t forget to replace with your device code !
Example for kiwi:
$ adb shell getprop ro.product.device
5. Get your image!
When your build is finished, please find your images inside /e/zips/ folder. To install, please refer to our wiki.
If you need help, please join us on our community support Telegram channel.
To find more information about our docker image and its environment variables here.
To report an issue about a build, please refer to wiki issues documentation