Skip to content

Latest commit

 

History

History
57 lines (45 loc) · 3.02 KB

README.md

File metadata and controls

57 lines (45 loc) · 3.02 KB
Raw

Port OEM ROMs to project treble using github actions and ErfanGSIs then upload to sourceforge.

Features

  • Easy to use.
  • Customizable. Chose your own custom ErfanGSIs tool, chose build type (A only or AB or both), and many more.
  • Deploy ported GSI to sourceforge.
  • Send notifications on telegram with informations about the latest build.

Requirements

  • A little understanding on how to use ErfanGSIs tool.
  • A SourceForge account and project.
  • A little understanding on how SourceForge works and how to use it with sftp.

How To Use

  • Fork the repo.
  • Setup ErfanGSIs configuration in config.env. See ErfanGSIs Configuration.
  • Setup SourceForge credentials in github secrets. See SourceForge Configuration.
  • Go to actions tab, enable workflows.
  • Go to Actions tab again, click and run workflow manually.
  • It should take around 10 to succesfully build and upload your builds to sourceforge.com.

How to update

  • Change ErfanGSIs configuration in config.env. ErfanGSIs Configuration.
  • Go to actions tab, click and run workflow manually.
  • It should take around 10 to succesfully build and upload your builds to sourceforge.com.

ErfanGSIs Configuration

All the settings for Erfan's tool is available by editing the config.env file.

Name Description Required
TOOL_REPO Repository from where to clone ErfanGSIs tool. Only change this if you are using a custom one.
URL Firmware download link or path on the repo.
FIRMWARE_TYPE Firmware type (eg: Pixel).
OUTPUT_TYPE Build type. Can be: "all" to build AB and AOnly; "ab" to build just AB; "a" to build just AOnly.
SOURCEFORGE_DIR The directory on sourceforge. See: https://sourceforge.net/p/forge/documentation/SFTP/#for-managing-file-releases
TG_CHAT_IDS List of telegram chat id separated by space where to send info about the latest builds. Set to 0 to disable telegram notifications.
SOURCEFORGE_URL Url to the sourceforge directory where the builds are uploaded. Used if telegram notifications are enabled.
EXTRA_ARGS Extra arguments to pass to url2GSI.sh script.

SourceForge Configuration

In order to connect to source forge you need some extra configuration variables in your repo secrets. See here.

Name Description
USERNAME SourceForge username.
PASSWORD SourceForge password.
TG_BOT_TOKEN Telegram Bot Token to send notification messages to. Used only if telegram notifications are enabled.

Donate

Remember that all the credits for the gsi porting tool belong to Erfan so if your GSI booted succesfully all of this is because of him. But if you wish to thank me for creating this github workflow and you find it helpfull you can also help me with a donation.