|
||
---|---|---|
.github | ||
src | ||
.gitignore | ||
apt_preferences | ||
Dockerfile | ||
LICENSE | ||
README.md |
docker-lineage-cicd
Docker microservice for LineageOS Continuous Integration and Continuous Deployment
Why Docker?
A fair number of dependencies is needed to build LineageOS, plus a Linux system (and a discrete knowledge of it). With Docker we give you a minimal Linux build system with all the tools and scripts already integrated, easing considerably the creation of your own LineageOS build.
Moreover Docker runs also on Microsoft Windows and Mac OS, which means that LineageOS can be built on such platforms without requiring a dual boot system or a manual set up of a Virtual Machine.
How do I install Docker?
The official Docker guides are well-written:
- Linux (Ubuntu, Debian, CentOS and Fedora are officially supported)
- Windows 10/Windows Server 2016 64bit
- Mac OS El Capitan 10.11 or newer
Life is considerably easier if you setup Docker to allow execution by non-root users: see 'Run the Docker daemon as a non-root user'
If your Windows or Mac system doesn't satisfy the requirements (or if you have Oracle VirtualBox installed, you can use Docker Toolbox. Docker Toolbox is not described in this guide, but it should be very similar to the standard Docker installation.
Once you can run the hello-world
image you're ready to
start!
What does Docker build
Docker will produce the following files in the zips
directory:
- the main ROM zip file e.g.
lineage-20.0-20230702-microG-<device-name>.zip
. This file can be flashed from recovery as described in the next section - a custom recovery image (e.g.
lineage-20.0-20230702-microG-<device-name>-recovery.img
orlineage-20.0-20230702-microG-<device-name>-boot.img
) and any other images needed or mentioned in the LineageOS installation instructions;- if the
ZIP_UP_IMAGES
environment variable is settrue
, these images will be zipped up into an-images.zip
file e.g.lineage-20.0-20230702-microG-<device-name>-images.zip
- else, if the
MAKE_IMG_ZIP_FILE
environment variable is settrue
the images are zipped into a flashable...-img.zip
file (e.g.lineage-20.0-20230702-microG-<device-name>-img.zip
) which can be installed usingfastboot flash
orfastboot update
- if the
How can I build LineageOS?
Before you start, make sure you have the latest version of our Docker image:
docker pull lineageos4microg/docker-lineage-cicd
The requirements for building LineageOS for MicroG are roughly the same as for building LineageOS:
-
A relatively recent x86_64 computer:
- Linux, macOS, or Windows - these instructions are only tested using Ubuntu 20.04 LTS, so we recommend going with that.
- A reasonable amount of RAM (16 GB to build up to lineage-17.1, 32 GB or more for lineage-18.1 and up). The less RAM you have, the longer the build will take. Enabling ZRAM can be helpful. If builds fail because of lack of memory, you can sometimes get over the problem by increasing the amount of swap, but this will be at the expense of slower build times.
- A reasonable amount of Storage (~300 GB for lineage-18.1 and up). You might require more free space for enabling ccache, building for multiple devices, or if you choose to mirror the LineageOS sources (see below). Using SSDs results in considerably faster build times than traditional hard drives.
-
A decent internet connection and reliable electricity. :)
-
Some familiarity with basic Android operation and terminology. It may be useful to know some basic command line concepts such as cd, which stands for “change directory”, the concept of directory hierarchies, and that in Linux they are separated by /, etc.
This Docker image contains a great number of settings, to allow you to fully customize your LineageOS build. Here you can find all of them, with the default values between the brackets.
TL;DR - go to the Examples
Fundamental settings
The two fundamental settings are:
BRANCH_NAME (lineage-16.0)
: LineageOS branch, see the branch list here (multiple comma-separated branches can be specified)DEVICE_LIST
: comma-separated list of devices to build
Running a build with only these two set will create a ZIP file almost identical to the LineageOS official builds, just signed with the test keys.
When multiple branches are selected, use DEVICE_LIST_<BRANCH_NAME>
to specify
the list of devices for each specific branch (see the examples).
GMS / microG
To include microG (or possibly the actual Google Mobile Services) in your build,
LineageOS expects certain Makefiles in vendor/partner_gms
and variable
WITH_GMS
set to true
.
This repo contains the common packages included for
official lineageos4microg builds. To include it in your build, create an XML
(the name is irrelevant, as long as it ends with .xml
) in the
/home/user/manifests
folder with this content:
<?xml version="1.0" encoding="UTF-8"?>
<manifest>
<project path="vendor/partner_gms" name="lineageos4microg/android_vendor_partner_gms" remote="github" revision="master" />
</manifest>
Additional custom apps
If you wish to add other apps to your ROM, you can include a repository with
source code or prebuilt APKs. For prebuilt apks, see the android_vendor_partner_gms
repository for examples on how the Android.mk
file should look like.
Include the repo with another manifest file like this:
<?xml version="1.0" encoding="UTF-8"?>
<manifest>
<project name="your-github-user/your-repo" path="prebuilts/my-custom-apps" remote="github" revision="master" />
</manifest>
And when starting the build, set the CUSTOM_PACKAGES
variable to a list of app names
(defined by LOCAL_MODULE
in Android.mk
) separated by spaces.
Signature spoofing
For LineageOS versions 18.1, 19.1, 20.0 and 21.0, built-in support for
signature spoofing has been added. This specifically only allows microG to
spoof its signature; no other apps are allowed to do so. If this is fine, the
SIGNATURE_SPOOFING
environment variable may be left unset (defaulting to
no
).
If not, two custom signature spoofing patches are provided:
- "Original" patches
- Restricted patches
With the "original" patch the FAKE_SIGNATURE permission can be granted to any user app: while it may seem handy, this is considered dangerous by a great number of people, as the user could accidentally give this permission to rogue apps.
A more strict option is the restricted patch, where the FAKE_SIGNATURE permission can be obtained only by privileged system apps, embedded in the ROM during the build process.
The custom signature spoofing patch can be optionally included with:
SIGNATURE_SPOOFING (no)
:yes
to use the original patch,restricted
for the restricted one,no
for none of them and to default to built-in signature spoofing.
If in doubt, use restricted
: note that packages that requires the
FAKE_SIGNATURE permission must be included in the build as system apps
(e.g. as part of GMS or CUSTOM_PACKAGES
)
These patches are currently disabled for LineageOS 21 entirely. If you have an use case which requires the use of custom patches on 21, please open an issue.
Proprietary files
Some proprietary files are needed to create a LineageOS build, but they're not included in the LineageOS repo for legal reasons. You can obtain these blobs in three ways:
- by pulling them from a running LineageOS
- by extracting them from a LineageOS ZIP
- by downloading them from TheMuppets GitHub and GitLab repositories (unofficial)
The third way is the easiest one and is enabled by default; if you're OK with
that just move on, otherwise set INCLUDE_PROPRIETARY (true)
to false
and
manually provide the blobs (not explained in this guide).
Over the Air updates
To enable OTA for you builds, you need to run a server that speaks the protocol
understood by the LineageOS updater app and provide the URL to this
server as OTA_URL
variable for the build.
One implementation is LineageOTA, which is also available as Docker image. Follow these steps to prepare your builds for OTA:
- Run the Docker image
julianxhokaxhiu/lineageota
- Port 80 exposed to the internet (might want to add an HTTPS reverse proxy)
- The
/srv/zips
directory/volume of the CICD image mounted at/var/www/html/builds/full
(can be read-only)
- Set environment variables when building
ZIP_SUBDIR
tofalse
OTA_URL
to the address of the OTA server, with/api
appended
If you don't setup a OTA server you won't be able to update the device from the updater app (but you can still update it manually with the recovery of course).
Signing
By default, builds are signed with the Android test keys. If you want to sign your builds with your own keys (highly recommended):
SIGN_BUILDS (false)
: set totrue
to sign the builds with the keys contained in/srv/keys
; if no keys are present, a new set will be generated
Settings to control 'switchable' build steps
Some of the the steps in the build process (e.g repo sync
, mka
) can take a long time to complete. When working on a build, it may be desirable to skip some of the steps. The following environment variables (and their default values) control whether or not each step is performed
# variables to control whether or not tasks are implemented
ENV INIT_MIRROR true
ENV SYNC_MIRROR true
ENV RESET_VENDOR_UNDO_PATCHES true
ENV CALL_REPO_INIT true
ENV CALL_REPO_SYNC true
ENV CALL_GIT_LFS_PULL false
ENV APPLY_PATCHES true
ENV PREPARE_BUILD_ENVIRONMENT true
ENV CALL_BREAKFAST true
ENV CALL_MKA true
ENV ZIP_UP_IMAGES false
ENV MAKE_IMG_ZIP_FILE false
To switch
an operation, change the default value of the the variable in a -e clause
in the docker run
command e.g.
-e "CALL_REPO-SYNC=false" \
The ZIP_UP_IMAGES
and MAKE_IMG_ZIP_FILE
variables control how the .img
files created by the buid are handled:
- by default, the
img
files are copied - unzipped - to thezips
directory - if
ZIP_UP_IMAGES
is settrue
, the images are zipped and the resulting...images.zip
is copied to thezips
directory - if
MAKE_IMG_ZIP_FILE
is settrue
, a flashsable...-img.zip
file is created, which can be installed usingfastboot flash
orfastboot update
Other settings
Other useful settings are:
CCACHE_SIZE (50G)
: change this if you want to give more (or less) space to ccacheRELEASE_TYPE (UNOFFICIAL)
: change the release type of your buildsBUILD_TYPE (userdebug)
: type of your builds, see Android docsBUILD_OVERLAY (false)
: normally each build is done on the source tree, then the tree is cleaned withmka clean
. If you want to be sure that each build is isolated from the others, setBUILD_OVERLAY
totrue
(longer build time). Requires--cap-add=SYS_ADMIN
.LOCAL_MIRROR (false)
: change this totrue
if you want to create a local mirror of the LineageOS source (> 200 GB)CRONTAB_TIME (now)
: instead of building immediately and exit, build at the specified time (uses standard cron format)ZIP_SUBDIR (true)
: Move the resulting zips to $ZIP_DIR/$codename instead of $ZIP_DIR/PARALLEL_JOBS
: Limit the number of parallel jobs to run (-j
forrepo sync
andmka
). By default, the build system should match the number of parallel jobs to the number of cpu cores on your machine. Reducing this number can help keeping it responsive for other tasks.RETRY_FETCHES
: Set the number of retries for the fetch duringrepo sync
. By default, this value is unset (defaultrepo sync
retry behavior). Positive values greater than 0 are allowed.
The full list of settings, including the less interesting ones not mentioned in this guide, can be found in the Dockerfile.
Volumes
You also have to provide Docker some volumes, where it'll store the source, the resulting builds, the cache and so on. The volumes are:
/srv/src
, for the LineageOS sources/srv/zips
, for the output builds/srv/logs
, for the output logs/srv/ccache
, for the ccache/srv/local_manifests
, for custom manifests (optional)/srv/userscripts
, for the user scripts (optional)
When SIGN_BUILDS
is true
/srv/keys
, for the signing keys
When BUILD_OVERLAY
is true
/srv/tmp
, for temporary files
When LOCAL_MIRROR
is true
:
/srv/mirror
, for the LineageOS mirror
Examples
Build for river (lineage-18.1, officially supported), test keys, no patches
docker run \
-e "BRANCH_NAME=lineage-18.1" \
-e "DEVICE_LIST=river" \
-v "/home/user/lineage:/srv/src" \
-v "/home/user/zips:/srv/zips" \
-v "/home/user/logs:/srv/logs" \
-v "/home/user/cache:/srv/ccache" \
lineageos4microg/docker-lineage-cicd
Build for bacon (lineage-17.1, officially supported), custom keys, restricted signature spoofing with integrated microG and FDroid
docker run \
-e "BRANCH_NAME=lineage-17.1" \
-e "DEVICE_LIST=bacon" \
-e "SIGN_BUILDS=true" \
-e "SIGNATURE_SPOOFING=restricted" \
-e "WITH_GMS=true" \
-v "/home/user/lineage:/srv/src" \
-v "/home/user/zips:/srv/zips" \
-v "/home/user/logs:/srv/logs" \
-v "/home/user/cache:/srv/ccache" \
-v "/home/user/keys:/srv/keys" \
-v "/home/user/manifests:/srv/local_manifests" \
lineageos4microg/docker-lineage-cicd
If there are already keys in /home/user/keys
they will be used, otherwise a
new set will be generated before starting the build (and will be used for every
subsequent build).
The microG and FDroid packages are not present in the LineageOS repositories, and must be provided e.g. through android_vendor_partner_gms.
Build for four devices on lineage-17.1 and lineage-18.1 (officially supported), custom keys, restricted signature spoofing with integrated microG and FDroid, custom OTA server
docker run \
-e "BRANCH_NAME=lineage-17.1,lineage-18.1" \
-e "DEVICE_LIST_LINEAGE_17_1=bacon,oneplus2" \
-e "DEVICE_LIST_LINEAGE_18_1=river,lake" \
-e "SIGN_BUILDS=true" \
-e "SIGNATURE_SPOOFING=restricted" \
-e "WITH_GMS=true" \
-e "OTA_URL=https://api.myserver.com/" \
-v "/home/user/lineage:/srv/src" \
-v "/home/user/zips:/srv/zips" \
-v "/home/user/logs:/srv/logs" \
-v "/home/user/cache:/srv/ccache" \
-v "/home/user/keys:/srv/keys" \
-v "/home/user/manifests:/srv/local_manifests" \
lineageos4microg/docker-lineage-cicd
Build for a6000 (not officially supported), custom keys, restricted signature spoofing with integrated microG and FDroid
As there is no official support for this device, we first have to include the
sources in the source tree through an XML in the /home/user/manifests
folder;
from this thread we get the links of:
- Device tree: https://github.com/dev-harsh1998/android_device_lenovo_a6000
- Common Tree: https://github.com/dev-harsh1998/android_device_lenovo_msm8916-common
- Kernel: https://github.com/dev-harsh1998/kernel_lenovo_msm8916
- Vendor blobs: https://github.com/dev-harsh1998/proprietary-vendor_lenovo
Then, with the help of lineage.dependencies from the
device tree and the
common tree we create an XML
/home/user/manifests/a6000.xml
with this content:
<?xml version="1.0" encoding="UTF-8"?>
<manifest>
<project name="dev-harsh1998/android_device_lenovo_a6000" path="device/lenovo/a6000" remote="github" />
<project name="dev-harsh1998/android_device_lenovo_msm8916-common" path="device/lenovo/msm8916-common" remote="github" />
<project name="dev-harsh1998/kernel_lenovo_msm8916" path="kernel/lenovo/a6000" remote="github" />
<project name="dev-harsh1998/proprietary-vendor_lenovo" path="vendor/lenovo" remote="github" />
<project name="LineageOS/android_device_qcom_common" path="device/qcom/common" remote="github" />
</manifest>
We also want to include microG so, like before, create an XML (for
example /home/user/manifests/microg.xml
) with this content:
<?xml version="1.0" encoding="UTF-8"?>
<manifest>
<project path="vendor/partner_gms" name="lineageos4microg/android_vendor_partner_gms" remote="github" revision="master" />
</manifest>
We also set INCLUDE_PROPRIETARY=false
, as the proprietary blobs are already
provided by the repo
https://github.com/dev-harsh1998/prorietary_vendor_lenovo (so we
don't have to include the TheMuppets repo).
Now we can just run the build like it was officially supported:
docker run \
-e "BRANCH_NAME=lineage-15.1" \
-e "DEVICE_LIST=a6000" \
-e "SIGN_BUILDS=true" \
-e "SIGNATURE_SPOOFING=restricted" \
-e "WITH_GMS=true" \
-e "INCLUDE_PROPRIETARY=false" \
-v "/home/user/lineage:/srv/src" \
-v "/home/user/zips:/srv/zips" \
-v "/home/user/logs:/srv/logs" \
-v "/home/user/cache:/srv/ccache" \
-v "/home/user/keys:/srv/keys" \
-v "/home/user/manifests:/srv/local_manifests" \
lineageos4microg/docker-lineage-cicd
Web Site text
The following should be published on the LineageOS for microG website. It is included here until the website can be updated
How do I install the LineageOS for MicroG ROM
Follow the LineageOS installation instructions for your device, which can be accessed from the LineageOS Devices wiki pages. If the LineageOS installation instructions require or refer to any .img
files, these images can be obtained by unzipping the -images.zip
file mentioned in the previous section.
'Clean' and 'dirty' flashing
A 'clean' flash is when the data partition is wiped and/or formatted before the ROM is installed. This will remove all user-installed apps and data. It is sometimes referred to as a 'fresh installation'.
A 'dirty flash' is when the data partition is not wiped and/or formatted before the ROM is installed. Normally this will result in all user-installed apps and data still being present after the installation.
Newer versions of the LineageOS for MicroG ROM can usually be 'dirty flashed' over older versions with the same Android version.
Dirty flashing is sometimes possible over
- older versions of the LineageOS for MicroG ROM with an earlier Android version**;
- the official LineageOS ROM (without microG)
In both these cases, problems may be encountered with app permissions, both for user-installed apps and for the pre-installed apps. These problems can sometimes be fixed by manually changing the app permissions.
If you are 'dirty' flashing, it is a good idea to backup your user-installed apps and data in case the 'dirty' flash fails.
Ugrade to a higher Android / LineageOS version
Upgrading from one version of LineageOS to a higher version (e.g. LineageOS 20.0, based on Android 13, to LineageOS 21.0 , based on Android 14) cannot be done by the Updater app. The new version will hav eto be installed manually. The instructions vary between devices, so find your device in the LineageOS Devices Wiki page and follow the links to the upgrade instrcutions for that device.
For some devices, the upgrade instructions specify that a factory reset / data wipe or format is required. If that is true for your device, do not ignore the requirement (in the hope that you won't lose your user-installed apps and data): if you do not perform the factory reset, your device will probably fail to boot after the upgrade. If you want to keep your user-installed apps and data and your device requres a factory reset, then checkout the solutions in this wiki page. They won't backup 'EVERYTHING' , but they are the best I've found.
Downgrading
Downgrading from one version of LineageOS for microG to an ealier or lower version, is generally not possible, even if they are the same Android version. If you want to do that, you will have to format your data partition and perform a clean installation. If you need to go down that path, then checkout the backup options descibed in the previous section.
Failed updates and 'boot loops'
Sometimes - up to now, pretty rarely - an update, either manual or OTA, may cause the phone to 'boot loop' (i.e. the phone repeatedly restarts without successfully loading the operating system), or to keep rebooting to recovery rather than the phone OS. The usual way to fix a boot loop, is to factory reset, by wiping or formatting the phone's data partiition which, as mentioned above, will delete all your user-installed apps and data.
So there is no easy way to fix a boot loop, without losing you user-installed apps and data, because re-installing an earlier, working version also usually requires a factory reset. If you don't have a backup of your user-installed apps and data, then you can try the following:
- wait for a new, fixed build to be made and published, and manually install it;
- try installing an earlier working build (you may also have to flash an earlier recovery, as recovery will usually not install a ROM that it older than the recovery). This may work, but probably won't:
- try flashing the latest LineageOS build from
https://download.lineageos.org/devices/<your-device-name>/builds
. You won't have a fully-working installation of LineageOS for microG, but you may be able to backup your user-installed apps and data.
Troubleshooting and support
The LineageOS for MicroG project is not in a position to offer much by way of technical support:
- the number of active volunteer maintainers / contributors is very small, and we spend what time we have trying to ensure that the process of making regular builds keeps going. We can generally investigate problems with the build tools, but not with the ROM itself;
- we don't have access to any devices for testing / debugging
The project issue tracker is mostly for tracking problems with the Docker build tool. It is not intended for tracking problems with installing or running the LineageOS for MicroG ROM. If you run into such problems, our advice is to work through the following steps to see if they help. (Make a backup of your user apps & data first):
- full power off and restart
- factory reset
- format data partition
- install the most recent LineageOS for MicroG build for your device, from here following the LOS installation instructions.
- install the latest official LineageOS build from here
For any problems, with building, installing, or running LineageOS for MicroG, we recommend that you ask for help in the XDA Forum thread or in device specific XDA forum threads. The LineageOS for MicroG forum thread is not maintained by us, but there are many knowledgeable contributors there, who build and run the LineageOS for MicroG ROM on a wide variety of devices.
Builds for devices no longer supported by LineageOS
When LineageOS stop supporting a device the last LineageOS for MicroG build for that device is moved to a device-specific subdirectory of https://download.lineage.microg.org/archive/
~Old builds will be kept here as long as possible, until we need to free up storage space on the download server~
Due to lack of disk space, we have had to move these old builds to storage which is not publicly visible. If you need to download an old build, then please post in our XDA Forum thread and we will find a way of making it available to you.
LineageOS for microG: Project Scope & Objectives
As the website says, the LineageOS for microG project is a
LineageOS unofficial fork with built-in microG gapps implementation
The prime objectives of the project are to:
- deliver regular builds of the project for all the phones and tablets[1] currently supported officially by LOS;
- create and maintain the source code, tools, and computing resources needed:
- to make the builds;
- to make the builds available for download, for manual and OTA installation.
Another - less central - objective is to allow other projects and individuals to use our source code and tools (though not currently our computing resources) to make and maintain their own builds:
- of L4M, 'vanilla' LOS, and / or other LOS-based custom ROMs;
- for other devices, whether or not supported officially.
Upstreams
The project has two main 'upstream` projects:
- LineageOS (website, github repos)
- MicroG (website, github repos)
Like LineageOS, the project also uses 'TheMuppets` github and gitlab repos as the source for device-specific vendor binary blobs.
The main work of the project is to integrate the upstream components and build them into the ROM images we make available.
Project Github repositories
The project has two main public repositories on GitHub:
docker-lineage-cicd
The Docker image used by the project to make the regular builds, along with aREADME.md
explaining how it can be used. The Docker images is rebuilt and pushed to DockerHub automatically when changes are pushed to themaster
branchandroid_vendor_partner_gms
The pre-built components from MicroG, along with makefiles for easy integration in the Android build system. The pre-built components are pulled automatically from the MicroG releases.
Project deliverables
- The device-specific ROM zip files.
- Device-specific
-images.zip
files containing any.img
files that are needed for installing or updating the ROM zip file (e.g.boot.img
,recovery.img
). - The Docker image used to make the builds, including the (limited) documentation in the
README.md
.
The ROM zips and other device-specific files are made available in sub-directories on the download server.
The Docker image is pushed to DockerHub.
Build Targets and Frequency
We build for the same devices as LineageOS using their list of build targets as the input to our build run.
We currently make builds monthly, starting on the first day of the month. The devices included in a build run are defined by the content of the LOS target list at the point the build run starts. Our monthly build run takes 15-16 days to complete. You can see the current status of the build in the dedicated matrix room
If builds for any devices fail during a build run, we will try the build again after the main build run has completed. If you do not see a new build for your device when you expect it, please check whether the build failure was reported in the matrix room. If it was, there is no need to report it - we will deal with it! If the failure was not reported in the matrix room, then please report it in our issue tracker or in the XDA Forums thread
Project Scope
The following items are explicitly not within the scope of the project
- Changes to, or forks of, upstream components, except where necessary for the correct operation of the integrated components. At present, this means only the signature spoofing patches that are needed for the correct operation of the MicroG software components (see Note 1)
- Maintaining, supporting or documenting the tools or binary files, needed for installation of our ROMs. This is within the scope of the LineageOS upstream, which either builds and makes available the necessary tools and files, or links to other projects (e.g. TWRP) which provide them
Project Status
The project is currently in a fairly stable state:
- we are (mostly) achieving our objective of delivering monthly builds
- the only essential work that is ongoing is to
- monitor the delivery process, to fix any problems that may occur, and to make any changes that are needed to ensure that the problems do not recur
- to make any changes needed when upstreams make changes. In particular, when LineageOS introduces support for a new Android version and / or drops support for older Android versions
The project is therefore - in the opinion of the currently active maintainers - essentially 'feature complete' and in 'maintenance' mode. The only change that we believe might significantly improve the project is to support other classes of Android devices, specifically
Minimal
&Android TV
devices (see Note 2)Treble-capable
devices which are not officially supported by LOS. As has recently been suggested building for thelineage_gsi
target would make our builds available for and usable on these devices.
Issue Reporting & Tracking
Our public github repos both have issue trackers, where any github user can create new issues. They are primarily intended for
- tracking problems with the components owned by the repos, i.e. the Docker image, and our integration of the microG components.
- asking questions about how to use the components
- suggesting improvements to those components e.g.
- ways in which the docker image could be changed to make the build process more efficient, or less error-prone
- how our limited documentation (primarily the
README.md
) could be improved
They are not intended for
- problems 'owned' by the upstream projects (see Note 3) e.g incorrect functionality, or requests for new or different functionality in
- apps which are 'built-in' to LineageOS
- microG components (unless the incorrect functionality is caused by our integration of those components)
- problems which are out of scope (see above)
- providing support for users of our ROMs (see below)
- requests for new features in our components (see Note 4). As mentioned above, we believe the project is 'feature complete', and the project does not have the time and / or resources to expand its scope, even if we thought such expansion was desirable. We will consider any such feature requests (when / if we have the time to do so), but the answer is likely to be negative.
One area where we know improvements can be made is in showing the progress (or lack of progress) in addressing reported issues:
- currently an issue is either 'Open' or 'Closed'
- no indication of whether 'Open' issues will be fixed or not
- no visibility of the priority of open issues, or when or in what order they will be addressed
- no indication of whether 'Closed' issues were fixed or not before closure
Some gradual changes are in hand to address this.
User Support
The project and the currently active maintainers do not have the time or resources to provide 'official' support for users of our ROMs. Fortunately, support and 'self-help' is available from the user community, in particular in the LineageOS for microG' XDA Forums thread.
Upstream projects have their own channels for supporting users.
Notes
- If such changes are needed, we will try to provide patches or Pull Requests to the upsteam components. We will only maintain our changes ourselves if the upstreams will not accept our changes
- L4M does not currently support building for
Minimal
orAndroid TV
devices, even when those devices are supported by LOS - This class of problem usually includes device-specific issues: we have no device-specific code, it all comes from upstream
- Any new issues or feature requests are more likely to be received positively if they are accompanied by code changes (in patches or - preferred - in Pull Requests) to fix the issue or implement the change. However, such changes will not be accepted just because code changes are provided.