Merge branch 'dev' into davinci

.github/FUNDING.yml

@@ -6,7 +6,7 @@ patreon: # Replace with a single Patreon username
 ko_fi: # Replace with a single Ko-fi username
 tidelift: # Replace with a single Tidelift platform-name/package-name e.g., npm/babel
 community_bridge: # Replace with a single Community Bridge project-name e.g., cloud-foundry
-liberapay: # Replace with a single Liberapay username
+liberapay: OpenAndroidInstaller
 issuehunt: # Replace with a single IssueHunt username
 otechie: # Replace with a single Otechie username
 lfx_crowdfunding: # Replace with a single LFX Crowdfunding project-name e.g., cloud-foundry

.github/ISSUE_TEMPLATE/bug_report.md

@@ -2,7 +2,7 @@
 name: Bug report
 about: Create a report to help us improve
 title: ''
-labels: ''
+labels: 'bug'
 assignees: ''
 
 ---

.github/ISSUE_TEMPLATE/device-support-request.yaml

@@ -0,0 +1,89 @@
+name: Device support request
+description: Request support for a new device
+title: Add support for <DEVICE>
+labels: ["device"]
+body:
+  - type: markdown
+    attributes:
+      value: "Thank you for your interest in OpenAndroidInstaller!"
+  - type: markdown
+    attributes:
+      value: "To get your device supported, please take the time to fill out this form."
+  - type: markdown
+    attributes:
+      value: "---"
+  - type: checkboxes
+    attributes:
+      label: Is your device already requested?
+      description: Please search to see if an issue for your device already exists.
+      options:
+      - label: I have searched the existing issues
+        required: true
+  - type: markdown
+    attributes:
+      value: "---"
+  - type: markdown
+    attributes:
+      value: "**Please input your device's details below:**"
+  - type: input
+    attributes:
+      label: Brand
+      description: The brand / manufacturer of your device
+      placeholder: Google
+    validations:
+      required: true
+  - type: input
+    attributes:
+      label: Name
+      description: The name of your device
+      placeholder: Pixel 3a
+    validations:
+      required: true
+  - type: input
+    attributes:
+      label: Device code
+      description: The device code OAI gave you in the error message
+      placeholder: sargo
+    validations:
+      required: true
+  - type: input
+    attributes:
+      label: Model
+      description: The model name of your device (only required, if there are several models)
+      placeholder: G020F
+    validations:
+      required: false
+  - type: markdown
+    attributes:
+      value: "---"
+  - type: textarea
+    attributes:
+      label: Device images
+      description: "Please provide links to any available images for the device, such as official stock firmware, Custom ROMs and Recoveries you would like to install."
+      placeholder: |
+        - Custom ROM: https://wiki.lineageos.org/devices/sargo
+        - Recovery: https://twrp.me/google/googlepixel3a.html
+      #value: |
+      #  - Custom ROM:
+      #  - Recovery:
+      #  - Stock firmware (if needed & existing):
+      render: Markdown
+    validations:
+      required: false
+  - type: markdown
+    attributes:
+      value: "---"
+  - type: checkboxes
+    attributes:
+      label: Do you own the device and would be willing to test the installer?
+      options:
+      - label: I own the device and am willing to test the installer on it.
+        required: true
+  - type: markdown
+    attributes:
+      value: "---"
+  - type: textarea
+    attributes:
+      label: Additional context
+      description: Please provide any additional context or information that might be helpful in adding support for this device. 
+      render: Markdown

.github/ISSUE_TEMPLATE/feature-request.md

@@ -2,7 +2,7 @@
 name: Feature request
 about: Suggest an idea for this project
 title: ''
-labels: ''
+labels: 'enhancement'
 assignees: ''
 
 ---

.github/workflows/build-release.yml

@@ -14,8 +14,8 @@ jobs:
       matrix:
         os: ['ubuntu-20.04', 'ubuntu-latest']
     steps:
-    - uses: actions/checkout@v2
-    - uses: actions/setup-python@v2
+    - uses: actions/checkout@v4
+    - uses: actions/setup-python@v4
       with:
         python-version: 3.9
     - run: pip install -r requirements.txt
@@ -32,8 +32,8 @@ jobs:
       matrix:
         os: ['ubuntu-20.04', 'ubuntu-latest', 'macos-latest']
     steps:
-    - uses: actions/checkout@v2
-    - uses: actions/setup-python@v2
+    - uses: actions/checkout@v4
+    - uses: actions/setup-python@v4
       with:
         python-version: 3.9
     - run: pip install -r requirements.txt
@@ -48,8 +48,8 @@ jobs:
     needs: ci
     runs-on: 'windows-latest'
     steps:
-    - uses: actions/checkout@v2
-    - uses: actions/setup-python@v2
+    - uses: actions/checkout@v4
+    - uses: actions/setup-python@v4
       with:
         python-version: 3.9
     - run: pip install -r requirements.txt
@@ -66,7 +66,7 @@ jobs:
       - build-windows
     runs-on: 'ubuntu-latest'
     steps:
-    - uses: actions/checkout@v2
+    - uses: actions/checkout@v4
     - name: Download artifact
       uses: actions/download-artifact@v3
     - name: Display structure of downloaded files
@@ -86,7 +86,7 @@ jobs:
     - name: Display structure of downloaded files
       run: ls -R
     - name: Create release
-      uses: marvinpinto/action-automatic-releases@latest
+      uses: dciborow/action-github-releases@v1.0.1
       if: startsWith(github.ref, 'refs/tags/')
       with:
         repo_token: ${{ secrets.GITHUB_TOKEN }}

.github/workflows/manual-build.yml

@@ -13,8 +13,8 @@ jobs:
         os: ['ubuntu-20.04', 'ubuntu-latest', 'macos-latest', 'windows-latest']
 
     steps:
-    - uses: actions/checkout@v2
-    - uses: actions/setup-python@v2
+    - uses: actions/checkout@v4
+    - uses: actions/setup-python@v4
       with:
         python-version: 3.9
     - run: pip install -r requirements.txt

README.md

@@ -27,20 +27,21 @@
   </p>
 </div>
 
-> **Warning**: This application is currently in beta state, so use at your own risk! While many people tested the application so far and we heard of no bricked devices, things might still go wrong.
-
-> **Note**: Unlocking the bootloader will erase all data on your device!
-This also includes your DRM keys, which are stored in the Trim Area partition (also called TA) in case your device is fairly recent and supports DRM L1. Those devices will be downgraded to DRM L3. Devices on DRM L3 by default will not be affected.
-Before proceeding, ensure the data you would like to retain is backed up to your PC and/or your Google account, or equivalent. Please note that OEM backup solutions like Samsung and Motorola backup may not be accessible from LineageOS once installed.
-If you wish to backup the TA partition first, you can find tutorials related to your device on the internet.
+> [!WARNING]
+> This application is currently in beta state, so use at your own risk! While many people tested the application so far and we heard of no bricked devices, things might still go wrong.
 
+> [!IMPORTANT]
+> Unlocking the bootloader will erase all data on your device!
+> This also includes your DRM keys, which are stored in the Trim Area partition (also called TA) in case your device is fairly recent and supports DRM L1. Those devices will be downgraded to DRM L3. Devices on DRM L3 by default will not be affected.
+> Before proceeding, ensure the data you would like to retain is backed up to your PC and/or your Google account, or equivalent. Please note that OEM backup solutions like Samsung and Motorola backup may not be accessible from LineageOS once installed.
+> If you wish to backup the TA partition first, you can find tutorials related to your device on the internet.
 
 ## Usage
 
 Linux is currently the best supported platform (tested with Ubuntu 20.04/22.04 LTS). Windows and MacOS are also supported but you might experience more issues. So far there is no support for ARM-based systems.
 
 1. Download the [.exe or appropriate executable file for your OS](https://github.com/openandroidinstaller-dev/openandroidinstaller/releases) from the releases or get the [official flatpak from flathub](https://flathub.org/apps/org.openandroidinstaller.OpenAndroidInstaller). You might need to change permissions to run the executable.
-    - On Windows also [install the Universal USB Drivers](https://adb.clockworkmod.com/) and other potentially drivers needed for your device.
+    - On Windows also [install the Universal USB Drivers](https://adb.clockworkmod.com) and other potentially drivers needed for your device.
 2. Download the custom ROM image and the TWRP recovery image for your device and optionally some addons. A source for files can be found on the following websites:
     - some custom ROMs:
       - [LineageOS](https://wiki.lineageos.org/devices)
@@ -82,11 +83,12 @@ Samsung | Galaxy Grand Prime VE | grandprimevelte | SM-G531F | tested
 Samsung | Galaxy S III Neo | s3ve3g | GT-I9301I | tested
 Samsung | Galaxy Tab S2 | [gts210vewifi](https://wiki.lineageos.org/devices/gts210vewifi/) | T813 | tested
 Samsung | Galaxy S4 Mini LTE| [serranoltexx](https://wiki.lineageos.org/devices/serranoltexx) | | tested
+Samsung | Galaxy S5 | [klte](https://wiki.lineageos.org/devices/klte) | G900F/M/R4/R7/T/V/W8 | tested
 Samsung | Galaxy S6 | [zerofltexx](https://wiki.lineageos.org/devices/zerofltexx) | | tested
 Samsung | Galaxy S6 Edge | [zeroltexx](https://wiki.lineageos.org/devices/zeroltexx) | | tested
 Samsung | Galaxy S7 | [herolte](https://wiki.lineageos.org/devices/herolte) | SM-G930F | tested
 Samsung | Galaxy S7 Edge | [hero2lte](https://wiki.lineageos.org/devices/hero2lte) | | tested
-Samsung | Galaxy S8 | [dreamlte](https://wiki.lineageos.org/devices/dreamlte) | | tested
+Samsung | Galaxy S8 | dreamlte | | tested
 Samsung | Galaxy S9 | [starlte](https://wiki.lineageos.org/devices/starlte) | | tested
 Samsung | Galaxy S10 | [beyond1lte](https://wiki.lineageos.org/devices/beyond1lte) | | tested
 Samsung | Galaxy S10e | [beyond0lte](https://wiki.lineageos.org/devices/beyond0lte) | | tested
@@ -173,19 +175,17 @@ OnePlus | 9 | lemonade | | under development
 
 Vendor | Device Name | CodeName | Models | Status
 ---|---|---|---|---
+Xiaomi | Redmi Note 7 | [lavender](https://wiki.lineageos.org/devices/lavender) |  | tested
+Xiaomi | Redmi 7A / 8 / 8A / 8A Dual | [Mi439](https://wiki.lineageos.org/devices/Mi439) : pine / olive / olivelite / olivewood | | tested
+Xiaomi | Redmi Note 8 / 8T | [ginkgo](https://wiki.lineageos.org/devices/ginkgo) / willow |  | untested
+Xiaomi | Redmi 9A / 9C / 9AT / 9i / 9A Sport / 10A / 10A Sport | garden / dandelion / blossom / angelican | | tested
 Xiaomi | Mi 9T / Redmi K20 | [davinci](https://wiki.lineageos.org/devices/davinci) / davinciin |  | untested
+Xiaomi | Redmi Note 9S / 9 Pro / 9 Pro Max / 10 Lite / Poco M2 pro | [miatoll](https://wiki.lineageos.org/devices/lavender) : gram / curtana / excalibur / joyeuse  |  | untested
+Xiaomi | Redmi Note 10S / 11SE / Poco M5S | [rosemary](https://wiki.lineageos.org/devices/rosemary) / maltose / secret /rosemary_p | | untested
 </details>
 
-And more to come!
-
 
-## Run OpenAndroidInstaller for development
-
-Currently development is only supported on Ubuntu Linux. MacOS and Windows should also work fine. You might need to install additional USB-drivers on Windows.
-
-1. Clone the main branch of this repository
-2. Run `make poetry` and `make install` to install poetry to manage python and install the required dependencies like adb, fastboot and heimdall.
-3. Run `make app` to start the desktop app from the source.
+And more to come!
 
 
 ## Contributing
@@ -199,62 +199,17 @@ All kinds of contributions are welcome. These include:
 - Add features and/or improve the code base.
 - Report bugs.
 
-More details on how to contribute can be found [here](https://github.com/openandroidinstaller-dev/openandroidinstaller/blob/main/CONTRIBUTING.md).
-Please have a look before opening an issue or starting to contribute.
-
-A detailed list can be found [here](https://openandroidinstaller.org/#contribute).
-
-### How to contribute your own installation configurations
-
-If you want to use the tool for a non-supported smartphone, the fastest way is to adapt an [existing config file](https://github.com/openandroidinstaller-dev/openandroidinstaller/tree/main/openandroidinstaller/assets/configs). The file should be named after the official `device code` of the device. Add the code output by `adb shell getprop | grep ro.product.device` (when the devices is connected to the computer) as well as the official device code to the `supported_device_codes` list in the config. You can also get the device code by connecting the device to the computer and run OpenAndroidInstaller to detect the device.
+[How to contribute your own installation configurations](https://github.com/openandroidinstaller-dev/openandroidinstaller/blob/main/docs/how_to_contribute_your_own_installation_configurations.md)
 
-**To test your config file with the executable** without using the developer setup, place it in the same directory as the executable. There it will be detected by name. After you created a config file and it works fine, you can open a pull request to make the file available to other users. Please also add the device to the supported devices table above.
+[How to build the application for your platform](https://github.com/openandroidinstaller-dev/openandroidinstaller/blob/main/docs/building_the_application_for_your_platform.md)
 
-#### Content of a config file
+[On unlocking the bootloader](https://github.com/openandroidinstaller-dev/openandroidinstaller/blob/main/docs/unlocking_the_bootloader.md)
 
-A config file consists of two parts. The first part are some metadata about the device and the second parts are the steps to unlock the bootloader, boot a recovery and install the ROMs.
-
-##### How to write Metadata
-Every config file should have `metadata` with the following fields:
-- `maintainer`: str; Maintainer and author of the config file.
-- `device_name`: str; Name of the device.
-- `is_ab_device`: bool; A boolean to determine if the device is a/b-partitioned or not.
-- `device_code`: str; The official device code.
-- `supported_device_codes`: List[str]; A list of supported device codes for the config. The config will be loaded based on this field.
-- `twrp-link`: [OPTIONAL] str; name of the corresponding twrp page.
-
-In addition to these metadata, every config can have optional `requirements`. If these are set, the user is asked to check if they are meet.
-- `android`: [OPTIONAL] int|str; Android version to install prior to installing a custom ROM.
-- `firmware`: [OPTIONAL] str; specific firmware version to install before installing a custom ROM.
-
-##### How to write steps:
-Every step in the config file corresponds to one view in the application. These steps should contain the following fields:
-- `type`: str; Corresponds to the type of view to generate. There are the following options:
-  - `text`: Just display the text given in content.
-  - `confirm_button`: Display the content, as well as a button to allow the user to go to the next step.
-  - `call_button`: Display the content text and a button that runs a given command. After the command is run, a confirm button is displayed to allow the user to move to the next step.
-  - `call_button_with_input`: Display the content text, an input field and a button that runs a given command. The inputtext, can be used in the command by using the `<inputtext>` placeholder in the command field. After the command is run, a confirm button is displayed to allow the user to move to the next step.
-  - `link_button_with_confirm`: Display a button that opens a browser with a given link, confirm afterwards. Link is given in `link`.
-- `img`: [OPTIONAL] Display an image on the left pane of the step view. Images are loaded from `openandroidinstaller/assets/imgs/`.
-- `content`: str; The content text displayed alongside the action of the step. Used to inform the user about what's going on. For consistency and better readability the text should be moved into the next line using `>`.
-- `link`: [OPTIONAL] Link to use for the link button if type is `link_button_with_confirm`.
-- `command`: [ONLY for call_button* steps] str; The command to run. One of `adb_reboot`, `adb_reboot_bootloader`, `adb_reboot_download`, `adb_sideload`, `adb_twrp_wipe_and_install`, `adb_twrp_copy_partitions`, `fastboot_boot_recovery`, `fastboot_unlock_with_code`, `fastboot_unlock`, `fastboot_oem_unlock`, `fastboot_get_unlock_data`, `fastboot_reboot`, `heimdall_flash_recovery`.
-- `allow_skip`: [OPTIONAL] boolean; If a skip button should be displayed to allow skipping this step. Can be useful when the bootloader is already unlocked.
-
-**Please try to retain this order of these fields in your config to ensure consistency.**
-
-## How to build the application for your platform
-
-The executables for the OpenAndroidInstaller are build with [pyinstaller](https://pyinstaller.org/en/stable/index.html). You can create builds for MacOS or Linux with `make build-app`. For Windows the paths need to be modified. For now, you can have a look [here](https://github.com/openandroidinstaller-dev/openandroidinstaller/blob/v0.1.2-alpha/.github/workflows/manual-build-windows.yml#L22) on how it's done.
-
-If you build the application for your platform and want to contribute the build, please reach out to me.
-
-#### On unlocking the bootloader
-Devices by *Samsung*, *Google* and *Fairphone* make it fairly easy to unlock the bootloader and receive good support in the installer.
+More details on how to contribute can be found [here](https://github.com/openandroidinstaller-dev/openandroidinstaller/blob/main/CONTRIBUTING.md).
+Please have a look before opening an issue or starting to contribute.
 
-Some devices with require manual steps to unlock the bootloader. In general you will need to create an account at a vendor website and receive some code from there. OpenAndroidInstaller will try to guide you as far as possible. These vendors include *Sony, Motorola, Xiaomi* and *OnePlus* among others.
+A detailed list can be found [here](https://openandroidinstaller.org/#contribute).
 
-Other phone vendors stops allowing to unlock the bootloader all together. There is nothing to be done if you didn't unlock your device in time. These vendors include *Huawei and LG* among others. Support for these vendors will always be very limited.
 
 ## Tools
 

docs/building_the_application_for_your_platform.md

@@ -0,0 +1,14 @@
+## How to build the application for your platform
+
+The executables for the OpenAndroidInstaller are build with [pyinstaller](https://pyinstaller.org/en/stable/index.html). You can create builds for MacOS or Linux with `make build-app`. For Windows the paths need to be modified. For now, you can have a look [here](https://github.com/openandroidinstaller-dev/openandroidinstaller/blob/v0.1.2-alpha/.github/workflows/manual-build-windows.yml#L22) on how it's done.
+
+If you build the application for your platform and want to contribute the build, please reach out to me.
+
+## Run OpenAndroidInstaller for development
+
+Currently development is only supported on Ubuntu Linux. MacOS and Windows should also work fine. You might need to install additional USB-drivers on Windows.
+
+1. Clone the main branch of this repository
+2. Run `make poetry` and `make install` to install poetry to manage python and install the required dependencies like adb, fastboot and heimdall.
+3. Run `make app` to start the desktop app from the source.
+