rabikishanr / crave_aosp_builder

crave_aosp_builder

Prerequisites

foss.crave.io account

Setup Instructions

• Download crave.conf from API Keys of foss.crave.io dashboard
• Fork this repo
• Go to (repo) Settings -> Security -> Secrets and Variables -> Actions
• Copy your username and authentication token from crave.conf
• Create a Repository Secret called CRAVE_USERNAME, with username from crave.conf
• Create a Repository Secret called CRAVE_TOKEN, with authentication token from crave.conf
• Go to Settings -> Code and Automation -> Actions -> General
• Set workflow Permissions to "Read and Write Permissions" and save.
• Edit .github/workflows/main.yml to change build hostname, build username, git username and git email to your liking

Extra Setup For Selfhosted runner:

• Follow the above steps
• On the top menu bar of the repository, click on Actions
• Self-Hosted Runner -> New Runner
• Enter Devspace https://opendroid.pugzarecute.com/wiki/Crave_Devspace#How_to_Prepare_Environment
• Follow the instructions given by github to set up your runner
• Do not run ./run.sh, instead, start your build through workflow dispatch

Inputs Explanation

Base Project

- These are the projects everyone can build, with a foss.crave.io account
- These are the ones officially added

Repo init Command

- This is only for when you are initializing another ROM. When doing this, ensure you are initializing on top of closest cousin base project
- Don't initialize android 14 on top of android 13 projects

Removals

- When we resync another ROM on top, we are bound to get "cannot checkout" errors. To fix this, we add that folder to the Removals tab
- Add a space after .repo/local_manifests and add these folders. Don't change if you don't need to

Local Manifest

- Here you enter the git repo and branch for your local manifests, containing device specific repositories. These will be cloned to .repo/local_manifests

Device Details

- Enter the device codename you want to build for inside DEVICE_NAME
- Enter the makefile name(without the .mk) inside MAKEFILE_NAME

Build Command

- eg. m updatepackage, mka bacon, make recoveryimage

Build Type

- Choose the build type

• user: Limited access; suited for production

• userdebug: Like user but with root access and debug capability; very close to production performance

• eng: Development configuration with faster build time; most suited for day-to-day development

Clean Build

• Uses fresh Base Project sources without any of our changes(use only for testing/debugging)

Known Issues

• You Tell Me :)

Extra Info

• For scheduled builds, it's better to remove the workflow dispatch stuff.
• This Repo is a spiritual successor to azwhikaru's Action-TWRP-Builder

Credits!

• AntoninoScordino for the recent rewrite
• azwhikaru's Action-TWRP-Builder Which I used as reference
• My Manifest tester (credits to AmogOS project for original logic)
• Other contributors
• The crave team for the build servers and helping us out when we get stuck