AppBrickie - Your Friendly App Builder Action.
Automate your android builds and get your APK delivered to you on Telegram Groups, Chat, Channels, any of them!
- Get your APK delivered to you on telegram with just a push of commit!
- Automated Android APK Builds.
- Unit Tests on Android Builds.
- Supports Firebase based apps and signed builds with your custom key!
- Forget wires, patches and building pull requests manually!
- Slack support coming soon! (star and watch the project to stay updated !)
Step 1: Add the following yaml file as build.yml in .github/workflows folder of your app repository.
Note: If your project uses any services of firebase, please refer to the WIKI for instructions. The below instructions are only for vanilla builds.
name: CI
on:
push:
branches: [master]
pull_request:
branches: [master]
jobs:
build:
runs-on: ubuntu-latest
name: App Brickie
steps:
- uses: actions/checkout@v2
- name: AppBrickie
id: appBrickieBuild
uses: DarthBenro008/[email protected]
with:
type: "native"
chatid: "Your Unique ID Goes here"
packagename: "Your App Name Goes Here"
- name: Get Automated Result
run: echo "${{ steps.appBrickieBuild.outputs.result }}"name: CI
on:
push:
branches: [master]
pull_request:
branches: [master]
jobs:
build:
runs-on: ubuntu-latest
name: App Brickie
steps:
- uses: actions/checkout@v2
- name: AppBrickie
id: appBrickieBuild
uses: DarthBenro008/[email protected]
with:
type: "flutter"
abi: "YOUR TARGET API" #Defaults to FAT APK
chatid: "Your Unique ID Goes here"
packagename: "Your App Name Goes Here"
- name: Get Automated Result
run: echo "${{ steps.appBrickieBuild.outputs.result }}"Checkout the WIKI Page for more detailed instructions!
Step 2 : Go To @AppBrickieBot on Telegram to generate your unique id.
Step 3: Replace your UniqueID from the bot in the YAML File above besides chatid in quotes for eg:
chatid: "qwerty12345"For Flutter Builds :
Specify the abi type you want to build, if you dont specify any by default it will build Fat APK.
| ABI Type | Code |
|---|---|
| armeabi-v7a | abi: "armabi-v7a" |
| arm64-v8a | abi: "arm64-v8a" |
| x86_64 | abi: "x86_64" |
| Default | FAT APK |
Step 4: Sit back and enjoy :D, get your build delivered to you on telegram automatically when a pull request or commit is created on master branch!
1. Custom Name - You can rename the app file name, by default its set to app-debug.apk, but to change that, add an input of packagename: "< YOUR APP NAME >"
Eg:
packagename: "myapp"2. Custom Key Sign - You can sign the app build by AppBrickie with your own keystore! Check the instreuctions mentions here to learn how to generate the secrets for a successful key sign build.
Eg:
keystore: ${{ secrets.KEYSTORE }}
keystorePassword: ${{ secrets.KEYSTORE_PASS }}
keyAlias: ${{ secrets.KEY_ALIAS }}
keyPassword: ${{ secrets.KEYSTORE_PASS }}3. Firebase - If your app uses any of the firebase services, copy the contents of google-service.json file and paste it in a secret and pass it in the input param as shown below. Check here for an example
firebase: ${{ secrets.FIREBASE }}- Slack integration
Note: v3.0 now supports firebase and custom build signing, refer changelog.
You automatically agree to accept the default android-sdk license by using this github action. For more info refer Android SDK T&C
👨💻 Hemanth Krishna @DarthBenro008
Give a ⭐ if this project made your life easy!
Spread the word to your App Developer fellows to make thier life easier too!
- Feel Free to Open a PR/Issue for any feature or bug(s).
- Make sure you follow the community guidelines!
- Feel free to open an issue to ask a question/discuss anything about AppBrickie.
- Have a feature request? Open an Issue!
Copyright 2020 Hemanth Krishna
Licensed under MIT License : https://opensource.org/licenses/MIT