build_manifests/README.md
2026-10-14 23:39:40 -04:00

60 lines
No EOL
2.1 KiB
Markdown

# build_manifests
Device manifests for A-Team recovery and ROM builds.
Each branch is one recovery or ROM base, and holds one XML file per device:
| Branch | Base |
|-------------|-----------------------|
| `twrp-12.1` | TWRP 12.1 |
| `ofrp-12.1` | OrangeFox R12.1 |
| `pbrp-12.1` | PitchBlack 12.1 |
| `shrp-12.1` | SkyHawk 12.1 |
| `aera-16.0` | AERA 16 |
## Device XML
Each `<codename>.xml` is a standard `repo` local manifest. It lists the device
tree, plus any other trees the device needs, on the branch matching the base.
The device tree project carries four annotations:
| Annotation | Meaning |
|----------------------|------------------------------------------------|
| `ateam.model` | Model number without the variant, e.g. `XT2301` |
| `ateam.device_name` | Marketing name, e.g. `Moto Edge+ 2023` |
| `ateam.manufacturer` | e.g. `Motorola` |
| `ateam.partition` | `recovery`, `boot` or `vendor_boot` |
Example:
```xml
<?xml version="1.0" encoding="UTF-8"?>
<manifest>
<remote name="ateam" fetch="ssh://git@ateam.gotadell.com/" />
<project path="device/motorola/rtwo"
name="A-Team_Digital_Solutions/recovery_device_motorola_rtwo"
remote="ateam" revision="twrp-12.1">
<annotation name="ateam.model" value="XT2301"/>
<annotation name="ateam.device_name" value="Moto Edge+ 2023"/>
<annotation name="ateam.manufacturer" value="Motorola"/>
<annotation name="ateam.partition" value="recovery"/>
</project>
</manifest>
```
## Adding a device
1. Copy an existing XML to `<codename>.xml` and edit the path, repo name and annotations.
2. Make sure the device tree has a branch matching the base.
3. Push to every base branch the device should build on. A model or name change has to be made on each of those branches too.
## Release naming
```
<RECOVERY>-<version>_A-Team_<codename>_<model>-<YYMMDD>.img
<RECOVERY>-<version>_A-Team_<codename>_<model>-<YYMMDD>.zip
```
Each file ships with a matching `.sha256`.