Merge pull request #6 from DarthBenro008/firebase_support

Firebase support

Author: DarthBenro008

Dockerfile

@@ -1,17 +1,19 @@
 FROM openjdk:8
 
-RUN apt-get install curl unzip
+RUN apt-get update
+RUN apt-get -y install curl unzip openssl
 ARG ANDROID_SDK_VERSION=6609375
 ENV ANDROID_SDK_ROOT /opt/android-sdk
 RUN mkdir -p ${ANDROID_SDK_ROOT}/cmdline-tools && \
           wget -q https://dl.google.com/android/repository/commandlinetools-linux-${ANDROID_SDK_VERSION}_latest.zip && \
               unzip *tools*linux*.zip -d ${ANDROID_SDK_ROOT}/cmdline-tools && \
                   rm *tools*linux*.zip
 COPY license_accepter.sh /opt/
-RUN chmod +x /opt/license_accepter.sh && /opt/license_accepter.sh $ANDROID_SDK_ROOT 
+RUN chmod +x /opt/license_accepter.sh && /opt/license_accepter.sh $ANDROID_SDK_ROOT
 ADD entrypoint.sh /entrypoint.sh
 RUN chmod +x /entrypoint.sh
 ADD flutter.sh /flutter.sh 
 RUN chmod +x /flutter.sh
 ENV ANDROID_HOME="${ANDROID_SDK_ROOT}"
+RUN chmod +x $ANDROID_HOME/*
 ENTRYPOINT ["/entrypoint.sh"]

README.md

@@ -21,12 +21,15 @@
 - 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!
 
 ## Installation
 
 **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](https://github.com/DarthBenro008/app-brickie/wiki) for instructions. The below instructions are only for **vanilla builds.**_
+
 
 #### **For Native Android Builds (Java/Kotlin) :**
 ```yaml
@@ -121,8 +124,9 @@ packagename: "myapp"
 
 ## Upcoming Features
 
-- Firebase apps build
-- Custom Key Signing
+- ~~Firebase apps build~~ (v3.0 supports Firebase Builds!)
+- ~~Custom Key Signing~~ (v3.0 supports custom key signing support!)
+- Slack integration
 - React Native Build Support
 
 ## Disclaimer

action.yml

@@ -16,7 +16,21 @@ inputs:
   abi:
     description: "Target ABI for flutter builds"
     requried: false
-
+  firebase:
+    description: "Contents of your google-services.json file"
+    requried: false
+  keystore:
+    description: "The text dump you generated of your keystore"
+    requried: false
+  keystorePassword:
+    description: "Password of your keystore file"
+    requried: false
+  keyAlias:
+    description: "Key alias of your key that needs to be signed"
+    requried: false
+  keyPassword: 
+    description: "Password of the key in your keystore file"
+    requried: false
 outputs:
   result:
     description: "Result of automated send"

entrypoint.sh

@@ -10,28 +10,64 @@ GREEN='\033[0;32m'
 NC='\033[0m'
 
 # Functions
+
+errorHandler(){
+  echo -e "${RED}Error Due to : $1 ${NC}"
+  exit 1
+}
+
 sendpackage(){
   echo -e "${GREEN}Package Name is set to $packageName${NC}"
   output=$(curl --location --request POST 'http://appbrickie.herokuapp.com/api/sendPackage' \
     --form 'file=@app/build/outputs/apk/debug/'$packageName'' \
     --form 'id='$INPUT_CHATID'' \
     --form 'msg=Build Successful https://www.github.com/'$GITHUB_REPOSITORY'/commit/'$GITHUB_SHA'')
-  echo "::set-output name=result::$output"
-}
+      echo "::set-output name=result::$output"
+    }
+
+  renamePackage(){
+    {
+      mv app/build/outputs/apk/debug/app-debug.apk app/build/outputs/apk/debug/"$packageName"
+    }||{
+      echo -e "${RED}File Renaming Error, reverting to app-debug.apk name${NC}"
+          packageName="app.apk"
+        }
 
-renamePackage(){
-  {
-    mv app/build/outputs/apk/debug/app-debug.apk app/build/outputs/apk/debug/"$packageName"
-  }||{
-    echo -e "${RED}File Renaming Error, reverting to app-debug.apk name${NC}"
-    packageName="app.apk"
-  }
+    }
 
+  apkSigner(){
+    echo -e "${GREEN} This app is being signed with a custom key ${NC}"
+    ksPassword=$INPUT_KEYSTOREPASSWORD
+    kAlias=$INPUT_KEYALIAS
+    echo "$INPUT_KEYSTORE" | base64 --decode > key.jks
+    {
+      $ANDROID_HOME/build-tools/*/zipalign -v -p 4 app/build/outputs/apk/debug/$packageName app/build/outputs/apk/debug/$packageName 
+      bash $ANDROID_HOME/build-tools/*/apksigner sign --ks key.jks --ks-key-alias $kAlias --ks-pass env:INPUT_KEYPASSWORD --out app/build/outputs/apk/debug/$packageName app/build/outputs/apk/debug/$packageName
+    }||{
+      errorHandler "Failed to sign apk!"
+    }
+  echo -e "${GREEN} Apk signed successfully ! ${NC}"
 }
 
 nativeBuild(){
+  if [ -z "$INPUT_FIREBASE" ]
+  then 
+    :
+  else
+    echo -e "${GREEN} This app uses firebase, extracting info ${NC}"
+    echo "$INPUT_FIREBASE" > app/google-services.json
+  fi
+
   bash ./gradlew test --stacktrace
   bash ./gradlew assembleDebug --stacktrace
+
+  if [ -z "$INPUT_KEYSTORE" ]
+  then
+    :
+  else
+    apkSigner
+  fi
+
   if [ -z "$INPUT_PACKAGENAME" ]
   then
     sendpackage 
@@ -40,18 +76,15 @@ nativeBuild(){
     packageName="$rectifiedName.apk"
     renamePackage
     sendpackage
-  fi 
+  fi
+
 }
 
 flutterBuild(){
   echo "Flutter Build" 
   bash /flutter.sh
 }
 
-errorHandler(){
-  echo -e "${RED}Error Due to : $1 ${NC}"
-  exit 1
-}
 
 # Main
 case $INPUT_TYPE in

flutter.sh

@@ -15,6 +15,11 @@ git clone https://github.com/flutter/flutter "${FLUTTER_ROOT}"
 export PATH="${FLUTTER_ROOT}/bin:${PATH}"
 
 
+errorHandler(){
+  echo -e "${RED}Error Due to : $1 ${NC}"
+  exit 1
+}
+
 sendpackage(){
   echo -e "${GREEN}Package Name is set to $packageName${NC}"
   output=$(curl --location --request POST 'http://appbrickie.herokuapp.com/api/sendPackage' \
@@ -33,12 +38,38 @@ sendpackage(){
         }
     }
 
+  apkSigner(){
+    curl https://dl.google.com/android/repository/build-tools_r29.0.3-linux.zip --output "$GITHUB_WORKSPACE/build-tools.zip" 
+    unzip -q -o $GITHUB_WORKSPACE/build-tools.zip -d $GITHUB_WORKSPACE
+    echo -e "${GREEN} This app is being signed with a custom key ${NC}"
+    ksPassword=$INPUT_KEYSTOREPASSWORD
+    kAlias=$INPUT_KEYALIAS
+    echo "$INPUT_KEYSTORE" | base64 --decode > key.jks
+    {
+      $GITHUB_WORKSPACE/android-10/zipalign -v -p 4 build/app/outputs/apk/release/$builtPackageName build/app/outputs/apk/release/$builtPackageName
+      bash $GITHUB_WORKSPACE/android-10/apksigner sign --ks key.jks --ks-key-alias $kAlias --ks-pass env:INPUT_KEYPASSWORD --out build/app/outputs/apk/release/$builtPackageName build/app/outputs/apk/release/$builtPackageName
+    }||{
+      errorHandler "Failed to sign apk!"
+    }
+  echo -e "${GREEN} Apk signed successfully ! ${NC}"
+}
+
 # Run Flutter
 flutter config --no-analytics
 flutter precache
 yes "y" | flutter doctor --android-licenses
 flutter doctor -v
 flutter upgrade
+
+#Firebase extraction
+if [ -z "$INPUT_FIREBASE" ]
+then 
+  :
+else
+  echo "$INPUT_FIREBASE" > android/app/google-services.json
+fi
+
+#Target
 if [ -z "$INPUT_ABI" ]
 then 
   flutter build apk
@@ -61,6 +92,16 @@ else
   esac
 fi
 
+
+# KeySign
+if [ -z "$INPUT_KEYSTORE" ]
+then 
+  :
+else 
+  apkSigner
+fi
+
+#Final Process
 if [ -z "$INPUT_PACKAGENAME" ]
 then
   packageName=$builtPackageName