├── app ├── .gitignore ├── src │ ├── main │ │ ├── res │ │ │ ├── values │ │ │ │ ├── strings.xml │ │ │ │ ├── colors.xml │ │ │ │ └── themes.xml │ │ │ ├── mipmap-hdpi │ │ │ │ ├── ic_launcher.png │ │ │ │ └── ic_launcher_round.png │ │ │ ├── mipmap-mdpi │ │ │ │ ├── ic_launcher.png │ │ │ │ └── ic_launcher_round.png │ │ │ ├── mipmap-xhdpi │ │ │ │ ├── ic_launcher.png │ │ │ │ └── ic_launcher_round.png │ │ │ ├── mipmap-xxhdpi │ │ │ │ ├── ic_launcher.png │ │ │ │ └── ic_launcher_round.png │ │ │ ├── mipmap-xxxhdpi │ │ │ │ ├── ic_launcher.png │ │ │ │ └── ic_launcher_round.png │ │ │ ├── mipmap-anydpi-v26 │ │ │ │ ├── ic_launcher.xml │ │ │ │ └── ic_launcher_round.xml │ │ │ ├── layout │ │ │ │ └── activity_main.xml │ │ │ ├── values-night │ │ │ │ └── themes.xml │ │ │ ├── drawable-v24 │ │ │ │ └── ic_launcher_foreground.xml │ │ │ └── drawable │ │ │ │ └── ic_launcher_background.xml │ │ ├── java │ │ │ └── com │ │ │ │ └── sharkawy │ │ │ │ └── android_cicd │ │ │ │ └── MainActivity.kt │ │ └── AndroidManifest.xml │ ├── test │ │ └── java │ │ │ └── com │ │ │ └── sharkawy │ │ │ └── android_cicd │ │ │ └── ExampleUnitTest.kt │ └── androidTest │ │ └── java │ │ └── com │ │ └── sharkawy │ │ └── android_cicd │ │ └── ExampleInstrumentedTest.kt ├── proguard-rules.pro ├── google-services.json └── build.gradle ├── .idea ├── .name ├── .gitignore ├── codeStyles │ ├── codeStyleConfig.xml │ └── Project.xml ├── compiler.xml ├── vcs.xml ├── misc.xml ├── gradle.xml └── jarRepositories.xml ├── settings.gradle ├── CI-CD-Image.png ├── release_apk.png ├── job_log_error.png ├── screenshots ├── config.png ├── disable.png ├── choose-org.png ├── gen-secret.png ├── import-org.png ├── update-dep.png ├── choose-repo.png ├── import-repo.png ├── new-project.png ├── new-project2.png └── sonar-result.png ├── gradle └── wrapper │ ├── gradle-wrapper.jar │ └── gradle-wrapper.properties ├── .gitignore ├── gradle.properties ├── .github └── workflows │ ├── build.yml │ └── pre_check.yml ├── gradlew.bat ├── Sonar-Cloud.md ├── gradlew └── README.md /app/.gitignore: -------------------------------------------------------------------------------- 1 | /build -------------------------------------------------------------------------------- /.idea/.name: -------------------------------------------------------------------------------- 1 | Android-CI CD -------------------------------------------------------------------------------- /settings.gradle: -------------------------------------------------------------------------------- 1 | include ':app' 2 | rootProject.name = "Android-CI CD" -------------------------------------------------------------------------------- /.idea/.gitignore: -------------------------------------------------------------------------------- 1 | # Default ignored files 2 | /shelf/ 3 | /workspace.xml 4 | -------------------------------------------------------------------------------- /CI-CD-Image.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/MGamalE/Android-CICD/HEAD/CI-CD-Image.png -------------------------------------------------------------------------------- /release_apk.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/MGamalE/Android-CICD/HEAD/release_apk.png -------------------------------------------------------------------------------- /job_log_error.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/MGamalE/Android-CICD/HEAD/job_log_error.png -------------------------------------------------------------------------------- /screenshots/config.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/MGamalE/Android-CICD/HEAD/screenshots/config.png -------------------------------------------------------------------------------- /screenshots/disable.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/MGamalE/Android-CICD/HEAD/screenshots/disable.png -------------------------------------------------------------------------------- /screenshots/choose-org.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/MGamalE/Android-CICD/HEAD/screenshots/choose-org.png -------------------------------------------------------------------------------- /screenshots/gen-secret.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/MGamalE/Android-CICD/HEAD/screenshots/gen-secret.png -------------------------------------------------------------------------------- /screenshots/import-org.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/MGamalE/Android-CICD/HEAD/screenshots/import-org.png -------------------------------------------------------------------------------- /screenshots/update-dep.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/MGamalE/Android-CICD/HEAD/screenshots/update-dep.png -------------------------------------------------------------------------------- /screenshots/choose-repo.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/MGamalE/Android-CICD/HEAD/screenshots/choose-repo.png -------------------------------------------------------------------------------- /screenshots/import-repo.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/MGamalE/Android-CICD/HEAD/screenshots/import-repo.png -------------------------------------------------------------------------------- /screenshots/new-project.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/MGamalE/Android-CICD/HEAD/screenshots/new-project.png -------------------------------------------------------------------------------- /screenshots/new-project2.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/MGamalE/Android-CICD/HEAD/screenshots/new-project2.png -------------------------------------------------------------------------------- /screenshots/sonar-result.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/MGamalE/Android-CICD/HEAD/screenshots/sonar-result.png -------------------------------------------------------------------------------- /app/src/main/res/values/strings.xml: -------------------------------------------------------------------------------- 1 | 2 | Android-CI CD 3 | -------------------------------------------------------------------------------- /gradle/wrapper/gradle-wrapper.jar: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/MGamalE/Android-CICD/HEAD/gradle/wrapper/gradle-wrapper.jar -------------------------------------------------------------------------------- /app/src/main/res/mipmap-hdpi/ic_launcher.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/MGamalE/Android-CICD/HEAD/app/src/main/res/mipmap-hdpi/ic_launcher.png -------------------------------------------------------------------------------- /app/src/main/res/mipmap-mdpi/ic_launcher.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/MGamalE/Android-CICD/HEAD/app/src/main/res/mipmap-mdpi/ic_launcher.png -------------------------------------------------------------------------------- /app/src/main/res/mipmap-xhdpi/ic_launcher.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/MGamalE/Android-CICD/HEAD/app/src/main/res/mipmap-xhdpi/ic_launcher.png -------------------------------------------------------------------------------- /app/src/main/res/mipmap-xxhdpi/ic_launcher.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/MGamalE/Android-CICD/HEAD/app/src/main/res/mipmap-xxhdpi/ic_launcher.png -------------------------------------------------------------------------------- /app/src/main/res/mipmap-xxxhdpi/ic_launcher.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/MGamalE/Android-CICD/HEAD/app/src/main/res/mipmap-xxxhdpi/ic_launcher.png -------------------------------------------------------------------------------- /app/src/main/res/mipmap-hdpi/ic_launcher_round.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/MGamalE/Android-CICD/HEAD/app/src/main/res/mipmap-hdpi/ic_launcher_round.png -------------------------------------------------------------------------------- /app/src/main/res/mipmap-mdpi/ic_launcher_round.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/MGamalE/Android-CICD/HEAD/app/src/main/res/mipmap-mdpi/ic_launcher_round.png -------------------------------------------------------------------------------- /app/src/main/res/mipmap-xhdpi/ic_launcher_round.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/MGamalE/Android-CICD/HEAD/app/src/main/res/mipmap-xhdpi/ic_launcher_round.png -------------------------------------------------------------------------------- /app/src/main/res/mipmap-xxhdpi/ic_launcher_round.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/MGamalE/Android-CICD/HEAD/app/src/main/res/mipmap-xxhdpi/ic_launcher_round.png -------------------------------------------------------------------------------- /app/src/main/res/mipmap-xxxhdpi/ic_launcher_round.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/MGamalE/Android-CICD/HEAD/app/src/main/res/mipmap-xxxhdpi/ic_launcher_round.png -------------------------------------------------------------------------------- /.idea/codeStyles/codeStyleConfig.xml: -------------------------------------------------------------------------------- 1 | 2 | 3 | 5 | -------------------------------------------------------------------------------- /.idea/compiler.xml: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | 6 | -------------------------------------------------------------------------------- /.idea/vcs.xml: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | 6 | -------------------------------------------------------------------------------- /gradle/wrapper/gradle-wrapper.properties: -------------------------------------------------------------------------------- 1 | #Sun Oct 17 11:35:24 EET 2021 2 | distributionBase=GRADLE_USER_HOME 3 | distributionPath=wrapper/dists 4 | zipStoreBase=GRADLE_USER_HOME 5 | zipStorePath=wrapper/dists 6 | distributionUrl=https\://services.gradle.org/distributions/gradle-6.5-bin.zip 7 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | *.iml 2 | .gradle 3 | /local.properties 4 | /.idea/caches 5 | /.idea/libraries 6 | /.idea/modules.xml 7 | /.idea/workspace.xml 8 | /.idea/navEditor.xml 9 | /.idea/assetWizardSettings.xml 10 | .DS_Store 11 | /build 12 | /captures 13 | .externalNativeBuild 14 | .cxx 15 | local.properties 16 | -------------------------------------------------------------------------------- /app/src/main/res/mipmap-anydpi-v26/ic_launcher.xml: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | -------------------------------------------------------------------------------- /app/src/main/res/mipmap-anydpi-v26/ic_launcher_round.xml: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | -------------------------------------------------------------------------------- /.idea/misc.xml: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | 6 | 7 | 9 | -------------------------------------------------------------------------------- /app/src/main/res/values/colors.xml: -------------------------------------------------------------------------------- 1 | 2 | 3 | #FFBB86FC 4 | #FF6200EE 5 | #FF3700B3 6 | #FF03DAC5 7 | #FF018786 8 | #FF000000 9 | #FFFFFFFF 10 | -------------------------------------------------------------------------------- /app/src/test/java/com/sharkawy/android_cicd/ExampleUnitTest.kt: -------------------------------------------------------------------------------- 1 | package com.sharkawy.android_cicd 2 | 3 | import org.junit.Test 4 | 5 | import org.junit.Assert.* 6 | 7 | /** 8 | * Example local unit test, which will execute on the development machine (host). 9 | * 10 | * See [testing documentation](http://d.android.com/tools/testing). 11 | */ 12 | class ExampleUnitTest { 13 | @Test 14 | fun addition_isCorrect() { 15 | assertEquals(4, 2 + 2) 16 | } 17 | } -------------------------------------------------------------------------------- /app/src/main/java/com/sharkawy/android_cicd/MainActivity.kt: -------------------------------------------------------------------------------- 1 | package com.sharkawy.android_cicd 2 | 3 | import android.os.Bundle 4 | import android.widget.Toast 5 | import androidx.appcompat.app.AppCompatActivity 6 | import com.google.android.gms.common.util.Strings 7 | 8 | class MainActivity : AppCompatActivity() { 9 | override fun onCreate(savedInstanceState: Bundle?) { 10 | super.onCreate(savedInstanceState) 11 | setContentView(R.layout.activity_main) 12 | 13 | 14 | Toast.makeText(this, "Hey! Firebase distributions integrated successfully! :)", Toast.LENGTH_SHORT).show() 15 | 16 | } 17 | 18 | 19 | } -------------------------------------------------------------------------------- /app/src/main/AndroidManifest.xml: -------------------------------------------------------------------------------- 1 | 2 | 4 | 5 | 12 | 13 | 14 | 15 | 16 | 17 | 18 | 19 | 20 | 21 | -------------------------------------------------------------------------------- /app/proguard-rules.pro: -------------------------------------------------------------------------------- 1 | # Add project specific ProGuard rules here. 2 | # You can control the set of applied configuration files using the 3 | # proguardFiles setting in build.gradle. 4 | # 5 | # For more details, see 6 | # http://developer.android.com/guide/developing/tools/proguard.html 7 | 8 | # If your project uses WebView with JS, uncomment the following 9 | # and specify the fully qualified class name to the JavaScript interface 10 | # class: 11 | #-keepclassmembers class fqcn.of.javascript.interface.for.webview { 12 | # public *; 13 | #} 14 | 15 | # Uncomment this to preserve the line number information for 16 | # debugging stack traces. 17 | #-keepattributes SourceFile,LineNumberTable 18 | 19 | # If you keep the line number information, uncomment this to 20 | # hide the original source file name. 21 | #-renamesourcefileattribute SourceFile -------------------------------------------------------------------------------- /app/src/androidTest/java/com/sharkawy/android_cicd/ExampleInstrumentedTest.kt: -------------------------------------------------------------------------------- 1 | package com.sharkawy.android_cicd 2 | 3 | import androidx.test.platform.app.InstrumentationRegistry 4 | import androidx.test.ext.junit.runners.AndroidJUnit4 5 | 6 | import org.junit.Test 7 | import org.junit.runner.RunWith 8 | 9 | import org.junit.Assert.* 10 | 11 | /** 12 | * Instrumented test, which will execute on an Android device. 13 | * 14 | * See [testing documentation](http://d.android.com/tools/testing). 15 | */ 16 | @RunWith(AndroidJUnit4::class) 17 | class ExampleInstrumentedTest { 18 | @Test 19 | fun useAppContext() { 20 | // Context of the app under test. 21 | val appContext = InstrumentationRegistry.getInstrumentation().targetContext 22 | assertEquals("com.sharkawy.android_cicd", appContext.packageName) 23 | } 24 | } -------------------------------------------------------------------------------- /app/src/main/res/layout/activity_main.xml: -------------------------------------------------------------------------------- 1 | 2 | 8 | 9 | 17 | 18 | -------------------------------------------------------------------------------- /.idea/gradle.xml: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | 20 | 21 | -------------------------------------------------------------------------------- /app/src/main/res/values/themes.xml: -------------------------------------------------------------------------------- 1 | 2 | 3 | 16 | -------------------------------------------------------------------------------- /app/src/main/res/values-night/themes.xml: -------------------------------------------------------------------------------- 1 | 2 | 3 | 16 | -------------------------------------------------------------------------------- /.idea/jarRepositories.xml: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | 9 | 10 | 14 | 15 | 19 | 20 | 24 | 25 | -------------------------------------------------------------------------------- /gradle.properties: -------------------------------------------------------------------------------- 1 | # Project-wide Gradle settings. 2 | # IDE (e.g. Android Studio) users: 3 | # Gradle settings configured through the IDE *will override* 4 | # any settings specified in this file. 5 | # For more details on how to configure your build environment visit 6 | # http://www.gradle.org/docs/current/userguide/build_environment.html 7 | # Specifies the JVM arguments used for the daemon process. 8 | # The setting is particularly useful for tweaking memory settings. 9 | org.gradle.jvmargs=-Xmx2048m -Dfile.encoding=UTF-8 10 | # When configured, Gradle will run in incubating parallel mode. 11 | # This option should only be used with decoupled projects. More details, visit 12 | # http://www.gradle.org/docs/current/userguide/multi_project_builds.html#sec:decoupled_projects 13 | # org.gradle.parallel=true 14 | # AndroidX package structure to make it clearer which packages are bundled with the 15 | # Android operating system, and which are packaged with your app"s APK 16 | # https://developer.android.com/topic/libraries/support-library/androidx-rn 17 | android.useAndroidX=true 18 | # Automatically convert third-party libraries to use AndroidX 19 | android.enableJetifier=true 20 | # Kotlin code style for this project: "official" or "obsolete": 21 | kotlin.code.style=official 22 | 23 | -------------------------------------------------------------------------------- /.github/workflows/build.yml: -------------------------------------------------------------------------------- 1 | # This workflow to help you automate your building process 2 | 3 | name: Integrate Firebase Distributions + Github Actions 4 | 5 | # Controls when the workflow will run 6 | on: 7 | # Triggers the workflow on push or pull request events but only for the master branch 8 | pull_request_target: 9 | branches: [ master ] 10 | 11 | 12 | 13 | jobs: 14 | builds: 15 | runs-on: ubuntu-latest 16 | steps: 17 | - name: Checkout 18 | uses: actions/checkout@v2 19 | 20 | - name: Setup Java JDK 21 | uses: actions/setup-java@v1 22 | with: 23 | java-version: 1.8 24 | 25 | - name: Build Gradle 26 | run: ./gradlew build 27 | 28 | - name: Upload a Build Artifact 29 | uses: actions/upload-artifact@v2 30 | with: 31 | name: app 32 | path: app/build/outputs/apk/debug/app-debug.apk 33 | 34 | - name: Upload Artifact To Firebase App Distribution 35 | uses: wzieba/Firebase-Distribution-Github-Action@v1.3.2 36 | with: 37 | appId: ${{ secrets.FIREBASE_ID }} 38 | token: ${{ secrets.FIREBASE_TOKEN }} 39 | groups: Android-CICD-Testers 40 | releaseNotes: "Hey! This my first integrate Firebase distributions with Github Actions" 41 | file: app/build/outputs/apk/debug/app-debug.apk 42 | 43 | -------------------------------------------------------------------------------- /app/google-services.json: -------------------------------------------------------------------------------- 1 | { 2 | "project_info": { 3 | "project_number": "477995420894", 4 | "project_id": "android-cicd-d338a", 5 | "storage_bucket": "android-cicd-d338a.appspot.com" 6 | }, 7 | "client": [ 8 | { 9 | "client_info": { 10 | "mobilesdk_app_id": "1:477995420894:android:48cf18466758a8d73d464f", 11 | "android_client_info": { 12 | "package_name": "com.sharkawy.android_cicd" 13 | } 14 | }, 15 | "oauth_client": [ 16 | { 17 | "client_id": "477995420894-qmi39md41hpsa2f8h19nmj62vc2inbpi.apps.googleusercontent.com", 18 | "client_type": 1, 19 | "android_info": { 20 | "package_name": "com.sharkawy.android_cicd", 21 | "certificate_hash": "bf251e6cb4c779e76742c9d99182f92262ccd803" 22 | } 23 | }, 24 | { 25 | "client_id": "477995420894-7t1h4rdj9bd6kki1bs482mirj5nid78i.apps.googleusercontent.com", 26 | "client_type": 3 27 | } 28 | ], 29 | "api_key": [ 30 | { 31 | "current_key": "AIzaSyAKfiPH_ppQM78JjQqmIGJuZ7ArtvZLlg0" 32 | } 33 | ], 34 | "services": { 35 | "appinvite_service": { 36 | "other_platform_oauth_client": [ 37 | { 38 | "client_id": "477995420894-7t1h4rdj9bd6kki1bs482mirj5nid78i.apps.googleusercontent.com", 39 | "client_type": 3 40 | } 41 | ] 42 | } 43 | } 44 | } 45 | ], 46 | "configuration_version": "1" 47 | } -------------------------------------------------------------------------------- /.github/workflows/pre_check.yml: -------------------------------------------------------------------------------- 1 | 2 | name: Build lint checker report, unit tests and static code analysis 3 | 4 | on: 5 | push: 6 | branches: [ master ] 7 | 8 | 9 | 10 | jobs: 11 | lint: 12 | runs-on: ubuntu-latest 13 | steps: 14 | - name: Checkout 15 | uses: actions/checkout@v2 16 | 17 | - name: Setup Java JDK 18 | uses: actions/setup-java@v1 19 | with: 20 | java-version: 1.8 21 | 22 | - name: Build Lint 23 | run: ./gradlew lintDebug 24 | 25 | - name: Upload Build Lint Report 26 | uses: actions/upload-artifact@v2 27 | with: 28 | name: report 29 | path: app/build/reports/lint-results-debug.html 30 | 31 | test: 32 | needs: [lint] 33 | runs-on: ubuntu-latest 34 | steps: 35 | - name: Checkout 36 | uses: actions/checkout@v2 37 | 38 | - name: Run Unit Tests 39 | run: ./gradlew test 40 | 41 | - name: Upload Unit Test Report 42 | uses: actions/upload-artifact@v2 43 | with: 44 | name: test-report 45 | path: app/build/reports/tests/testDebugUnitTest/ 46 | 47 | code_analysis: 48 | needs: [test] 49 | runs-on: ubuntu-latest 50 | steps: 51 | - name: Checkout 52 | uses: actions/checkout@v2 53 | 54 | - name: Setup Java JDK 55 | uses: actions/setup-java@v1 56 | with: 57 | java-version: 11 58 | 59 | - name: Upload Code Anaylysis To SonarCloud 60 | run: ./gradlew build sonarqube --info 61 | env: 62 | GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} 63 | SONAR_TOKEN: ${{ secrets.SONAR_TOKEN }} 64 | -------------------------------------------------------------------------------- /app/src/main/res/drawable-v24/ic_launcher_foreground.xml: -------------------------------------------------------------------------------- 1 | 7 | 8 | 9 | 15 | 18 | 21 | 22 | 23 | 24 | 30 | -------------------------------------------------------------------------------- /app/build.gradle: -------------------------------------------------------------------------------- 1 | plugins { 2 | id 'com.android.application' 3 | id 'kotlin-android' 4 | id 'com.google.gms.google-services' 5 | id("org.sonarqube") version "3.3" 6 | 7 | } 8 | 9 | android { 10 | compileSdkVersion 30 11 | buildToolsVersion "30.0.3" 12 | 13 | defaultConfig { 14 | applicationId "com.sharkawy.android_cicd" 15 | minSdkVersion 16 16 | targetSdkVersion 30 17 | versionCode 1 18 | versionName "1.0" 19 | 20 | testInstrumentationRunner "androidx.test.runner.AndroidJUnitRunner" 21 | } 22 | 23 | buildTypes { 24 | release { 25 | minifyEnabled false 26 | proguardFiles getDefaultProguardFile('proguard-android-optimize.txt'), 'proguard-rules.pro' 27 | } 28 | } 29 | compileOptions { 30 | sourceCompatibility JavaVersion.VERSION_1_8 31 | targetCompatibility JavaVersion.VERSION_1_8 32 | } 33 | kotlinOptions { 34 | jvmTarget = '1.8' 35 | } 36 | } 37 | 38 | dependencies { 39 | 40 | implementation "org.jetbrains.kotlin:kotlin-stdlib:$kotlin_version" 41 | implementation 'androidx.core:core-ktx:1.6.0' 42 | implementation 'androidx.appcompat:appcompat:1.3.1' 43 | implementation 'com.google.android.material:material:1.4.0' 44 | implementation 'androidx.constraintlayout:constraintlayout:2.1.1' 45 | testImplementation 'junit:junit:4.+' 46 | androidTestImplementation 'androidx.test.ext:junit:1.1.3' 47 | androidTestImplementation 'androidx.test.espresso:espresso-core:3.4.0' 48 | 49 | implementation platform('com.google.firebase:firebase-bom:28.4.2') 50 | implementation 'com.google.firebase:firebase-analytics-ktx' 51 | 52 | } 53 | 54 | sonarqube { 55 | properties { 56 | property "sonar.projectKey", "MohamedGElsharkawy_Android-CICD" 57 | property "sonar.organization", "mohamedgelsharkawy" 58 | property "sonar.host.url", "https://sonarcloud.io" 59 | } 60 | } -------------------------------------------------------------------------------- /gradlew.bat: -------------------------------------------------------------------------------- 1 | @if "%DEBUG%" == "" @echo off 2 | @rem ########################################################################## 3 | @rem 4 | @rem Gradle startup script for Windows 5 | @rem 6 | @rem ########################################################################## 7 | 8 | @rem Set local scope for the variables with windows NT shell 9 | if "%OS%"=="Windows_NT" setlocal 10 | 11 | set DIRNAME=%~dp0 12 | if "%DIRNAME%" == "" set DIRNAME=. 13 | set APP_BASE_NAME=%~n0 14 | set APP_HOME=%DIRNAME% 15 | 16 | @rem Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script. 17 | set DEFAULT_JVM_OPTS= 18 | 19 | @rem Find java.exe 20 | if defined JAVA_HOME goto findJavaFromJavaHome 21 | 22 | set JAVA_EXE=java.exe 23 | %JAVA_EXE% -version >NUL 2>&1 24 | if "%ERRORLEVEL%" == "0" goto init 25 | 26 | echo. 27 | echo ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH. 28 | echo. 29 | echo Please set the JAVA_HOME variable in your environment to match the 30 | echo location of your Java installation. 31 | 32 | goto fail 33 | 34 | :findJavaFromJavaHome 35 | set JAVA_HOME=%JAVA_HOME:"=% 36 | set JAVA_EXE=%JAVA_HOME%/bin/java.exe 37 | 38 | if exist "%JAVA_EXE%" goto init 39 | 40 | echo. 41 | echo ERROR: JAVA_HOME is set to an invalid directory: %JAVA_HOME% 42 | echo. 43 | echo Please set the JAVA_HOME variable in your environment to match the 44 | echo location of your Java installation. 45 | 46 | goto fail 47 | 48 | :init 49 | @rem Get command-line arguments, handling Windows variants 50 | 51 | if not "%OS%" == "Windows_NT" goto win9xME_args 52 | 53 | :win9xME_args 54 | @rem Slurp the command line arguments. 55 | set CMD_LINE_ARGS= 56 | set _SKIP=2 57 | 58 | :win9xME_args_slurp 59 | if "x%~1" == "x" goto execute 60 | 61 | set CMD_LINE_ARGS=%* 62 | 63 | :execute 64 | @rem Setup the command line 65 | 66 | set CLASSPATH=%APP_HOME%\gradle\wrapper\gradle-wrapper.jar 67 | 68 | @rem Execute Gradle 69 | "%JAVA_EXE%" %DEFAULT_JVM_OPTS% %JAVA_OPTS% %GRADLE_OPTS% "-Dorg.gradle.appname=%APP_BASE_NAME%" -classpath "%CLASSPATH%" org.gradle.wrapper.GradleWrapperMain %CMD_LINE_ARGS% 70 | 71 | :end 72 | @rem End local scope for the variables with windows NT shell 73 | if "%ERRORLEVEL%"=="0" goto mainEnd 74 | 75 | :fail 76 | rem Set variable GRADLE_EXIT_CONSOLE if you need the _script_ return code instead of 77 | rem the _cmd.exe /c_ return code! 78 | if not "" == "%GRADLE_EXIT_CONSOLE%" exit 1 79 | exit /b 1 80 | 81 | :mainEnd 82 | if "%OS%"=="Windows_NT" endlocal 83 | 84 | :omega 85 | -------------------------------------------------------------------------------- /Sonar-Cloud.md: -------------------------------------------------------------------------------- 1 | ## How to integrate sonar cloud with your project 2 | 3 | Before starting the integratation, you have to login with your account on [sonarcloud](https://sonarcloud.io/sessions/new) 4 | 5 | * After login to your account, you will see importing an organization option, so click `importing an organization from github` 6 |

7 | 8 | 9 |

10 | 11 | 12 | * After that, select your `organzaiton` which will you will integrate with it. 13 |

14 | 15 |

16 | 17 | 18 | * You will be navigated to your github to complete the installing for needed repository, 19 | you select `only selected repositories` option, then determine your repository and click save 20 | 21 |

22 | 23 |

24 | 25 | * :rocket: Greate!, now back to your sonarcloud account and Select `analyze new project` 26 | 27 |

28 | 29 |

30 | 31 | - If you have been imported any project before, and want to add a new one, from top header select `+` then `analyze new project` 32 | 33 |

34 | 35 |

36 | 37 | 38 | * Choose your repository, then click `setup` 39 |

40 | 41 |

42 | 43 | 44 | * Congrats :tada:, you have completed your setup, so now you have to disable your `Automatic analysis` from `project settings /Analysis method`, toggle `sonarcloud automatic analysis` to `off` 45 | - **`Important: if you didn't disable the automatic anaylsis option your pipeline will not work`** 46 |

47 | 48 |

49 | 50 | * From project settings select `anlyasis method`, then click `follow the toturial for github action` 51 |

52 | 53 |

54 | 55 | * You will be navigated to complete the integration steps, first step copy the generated secret token, then store it into your `github repository/settings/secrets` with key name `SONAR_TOKEN` 56 |

57 | 58 |

59 | 60 | * Second step copy your dependencies into your android studio project, then sync your project 61 |

62 | 63 |

64 | 65 | 66 | * Back to your github repository, and add this action for the sonarlcoud job in your workflow 67 | ``` 68 | - name: Upload Code Anaylysis To SonarCloud 69 | run: ./gradlew build sonarqube --info 70 | env: 71 | GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} 72 | SONAR_TOKEN: ${{ secrets.SONAR_TOKEN }} 73 | ``` 74 | 75 | * Congrats :tada: your project is ready :rocket: to run the pipeline 76 | 77 |

78 | 79 |

80 | 81 | 82 | 83 | -------------------------------------------------------------------------------- /.idea/codeStyles/Project.xml: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 6 | 7 | 119 | 120 | 122 | 123 | -------------------------------------------------------------------------------- /gradlew: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env sh 2 | 3 | ############################################################################## 4 | ## 5 | ## Gradle start up script for UN*X 6 | ## 7 | ############################################################################## 8 | 9 | # Attempt to set APP_HOME 10 | # Resolve links: $0 may be a link 11 | PRG="$0" 12 | # Need this for relative symlinks. 13 | while [ -h "$PRG" ] ; do 14 | ls=`ls -ld "$PRG"` 15 | link=`expr "$ls" : '.*-> \(.*\)$'` 16 | if expr "$link" : '/.*' > /dev/null; then 17 | PRG="$link" 18 | else 19 | PRG=`dirname "$PRG"`"/$link" 20 | fi 21 | done 22 | SAVED="`pwd`" 23 | cd "`dirname \"$PRG\"`/" >/dev/null 24 | APP_HOME="`pwd -P`" 25 | cd "$SAVED" >/dev/null 26 | 27 | APP_NAME="Gradle" 28 | APP_BASE_NAME=`basename "$0"` 29 | 30 | # Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script. 31 | DEFAULT_JVM_OPTS="" 32 | 33 | # Use the maximum available, or set MAX_FD != -1 to use that value. 34 | MAX_FD="maximum" 35 | 36 | warn () { 37 | echo "$*" 38 | } 39 | 40 | die () { 41 | echo 42 | echo "$*" 43 | echo 44 | exit 1 45 | } 46 | 47 | # OS specific support (must be 'true' or 'false'). 48 | cygwin=false 49 | msys=false 50 | darwin=false 51 | nonstop=false 52 | case "`uname`" in 53 | CYGWIN* ) 54 | cygwin=true 55 | ;; 56 | Darwin* ) 57 | darwin=true 58 | ;; 59 | MINGW* ) 60 | msys=true 61 | ;; 62 | NONSTOP* ) 63 | nonstop=true 64 | ;; 65 | esac 66 | 67 | CLASSPATH=$APP_HOME/gradle/wrapper/gradle-wrapper.jar 68 | 69 | # Determine the Java command to use to start the JVM. 70 | if [ -n "$JAVA_HOME" ] ; then 71 | if [ -x "$JAVA_HOME/jre/sh/java" ] ; then 72 | # IBM's JDK on AIX uses strange locations for the executables 73 | JAVACMD="$JAVA_HOME/jre/sh/java" 74 | else 75 | JAVACMD="$JAVA_HOME/bin/java" 76 | fi 77 | if [ ! -x "$JAVACMD" ] ; then 78 | die "ERROR: JAVA_HOME is set to an invalid directory: $JAVA_HOME 79 | 80 | Please set the JAVA_HOME variable in your environment to match the 81 | location of your Java installation." 82 | fi 83 | else 84 | JAVACMD="java" 85 | which java >/dev/null 2>&1 || die "ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH. 86 | 87 | Please set the JAVA_HOME variable in your environment to match the 88 | location of your Java installation." 89 | fi 90 | 91 | # Increase the maximum file descriptors if we can. 92 | if [ "$cygwin" = "false" -a "$darwin" = "false" -a "$nonstop" = "false" ] ; then 93 | MAX_FD_LIMIT=`ulimit -H -n` 94 | if [ $? -eq 0 ] ; then 95 | if [ "$MAX_FD" = "maximum" -o "$MAX_FD" = "max" ] ; then 96 | MAX_FD="$MAX_FD_LIMIT" 97 | fi 98 | ulimit -n $MAX_FD 99 | if [ $? -ne 0 ] ; then 100 | warn "Could not set maximum file descriptor limit: $MAX_FD" 101 | fi 102 | else 103 | warn "Could not query maximum file descriptor limit: $MAX_FD_LIMIT" 104 | fi 105 | fi 106 | 107 | # For Darwin, add options to specify how the application appears in the dock 108 | if $darwin; then 109 | GRADLE_OPTS="$GRADLE_OPTS \"-Xdock:name=$APP_NAME\" \"-Xdock:icon=$APP_HOME/media/gradle.icns\"" 110 | fi 111 | 112 | # For Cygwin, switch paths to Windows format before running java 113 | if $cygwin ; then 114 | APP_HOME=`cygpath --path --mixed "$APP_HOME"` 115 | CLASSPATH=`cygpath --path --mixed "$CLASSPATH"` 116 | JAVACMD=`cygpath --unix "$JAVACMD"` 117 | 118 | # We build the pattern for arguments to be converted via cygpath 119 | ROOTDIRSRAW=`find -L / -maxdepth 1 -mindepth 1 -type d 2>/dev/null` 120 | SEP="" 121 | for dir in $ROOTDIRSRAW ; do 122 | ROOTDIRS="$ROOTDIRS$SEP$dir" 123 | SEP="|" 124 | done 125 | OURCYGPATTERN="(^($ROOTDIRS))" 126 | # Add a user-defined pattern to the cygpath arguments 127 | if [ "$GRADLE_CYGPATTERN" != "" ] ; then 128 | OURCYGPATTERN="$OURCYGPATTERN|($GRADLE_CYGPATTERN)" 129 | fi 130 | # Now convert the arguments - kludge to limit ourselves to /bin/sh 131 | i=0 132 | for arg in "$@" ; do 133 | CHECK=`echo "$arg"|egrep -c "$OURCYGPATTERN" -` 134 | CHECK2=`echo "$arg"|egrep -c "^-"` ### Determine if an option 135 | 136 | if [ $CHECK -ne 0 ] && [ $CHECK2 -eq 0 ] ; then ### Added a condition 137 | eval `echo args$i`=`cygpath --path --ignore --mixed "$arg"` 138 | else 139 | eval `echo args$i`="\"$arg\"" 140 | fi 141 | i=$((i+1)) 142 | done 143 | case $i in 144 | (0) set -- ;; 145 | (1) set -- "$args0" ;; 146 | (2) set -- "$args0" "$args1" ;; 147 | (3) set -- "$args0" "$args1" "$args2" ;; 148 | (4) set -- "$args0" "$args1" "$args2" "$args3" ;; 149 | (5) set -- "$args0" "$args1" "$args2" "$args3" "$args4" ;; 150 | (6) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" ;; 151 | (7) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" ;; 152 | (8) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" "$args7" ;; 153 | (9) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" "$args7" "$args8" ;; 154 | esac 155 | fi 156 | 157 | # Escape application args 158 | save () { 159 | for i do printf %s\\n "$i" | sed "s/'/'\\\\''/g;1s/^/'/;\$s/\$/' \\\\/" ; done 160 | echo " " 161 | } 162 | APP_ARGS=$(save "$@") 163 | 164 | # Collect all arguments for the java command, following the shell quoting and substitution rules 165 | eval set -- $DEFAULT_JVM_OPTS $JAVA_OPTS $GRADLE_OPTS "\"-Dorg.gradle.appname=$APP_BASE_NAME\"" -classpath "\"$CLASSPATH\"" org.gradle.wrapper.GradleWrapperMain "$APP_ARGS" 166 | 167 | # by default we should be in the correct project dir, but when run from Finder on Mac, the cwd is wrong 168 | if [ "$(uname)" = "Darwin" ] && [ "$HOME" = "$PWD" ]; then 169 | cd "$(dirname "$0")" 170 | fi 171 | 172 | exec "$JAVACMD" "$@" 173 | -------------------------------------------------------------------------------- /app/src/main/res/drawable/ic_launcher_background.xml: -------------------------------------------------------------------------------- 1 | 2 | 7 | 10 | 15 | 20 | 25 | 30 | 35 | 40 | 45 | 50 | 55 | 60 | 65 | 70 | 75 | 80 | 85 | 90 | 95 | 100 | 105 | 110 | 115 | 120 | 125 | 130 | 135 | 140 | 145 | 150 | 155 | 160 | 165 | 170 | 171 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | ## Android-CICD 2 | 3 | This repo demonstrates how to work on CI/CD for Mobile Apps :iphone: using Github Actions :pill: + Firebase Distribution :tada: 4 | 5 | # Getting Started 6 | 7 | We are here setup a continious integration pipelines using [**Github Actions**](https://github.com/features/actions) and a continious delivery using [**Firebase Distribution**](https://firebase.google.com/docs/app-distribution) ⚡ ⚡ 8 | 9 | If you want to know a brief definition for the two terms CI/CD 🙆‍♂️, Checkout out the quotes : 10 | 11 | * [Continuous Integration](https://en.wikipedia.org/wiki/Continuous_integration) 12 | 13 | > Is the practice of merging all developers' working copies to a shared mainline several times a day. 14 | 15 | * [Continuous Delivery](https://en.wikipedia.org/wiki/Continuous_delivery) 16 | 17 | > Is a software engineering approach in which teams produce software in short cycles, 18 | > ensuring that the software can be reliably released at any time and, when releasing the software, without doing so manually. 19 | 20 | 21 | ![CI/CD](https://github.com/MohamedGElsharkawy/Android-CICD/blob/master/CI-CD-Image.png) 22 | 23 | 24 | # Workflows 25 | 26 | * 🚀 [pre_check.yaml](https://github.com/MohamedGElsharkawy/Android-CICD/blob/master/.github/workflows/pre_check.yml) : This workflow have to check for lint, testing and static code analyzer 27 | * 🚀 [build.yaml](https://github.com/MohamedGElsharkawy/Android-CICD/blob/master/.github/workflows/build.yml) : This workflow have to build and deploy to firebase distribution 28 | 29 | ## Getting Started With CI ⚡ 30 | 31 | To get start with build CI pipelines, you should use **Actions tab** or create a new **YAML** file, then you could setup your workflow, please checkout [Metadata syntax for GitHub Actions](https://docs.github.com/en/actions/creating-actions/metadata-syntax-for-github-actions) :monocle_face: 32 | 33 | ### How to create your own workflow 34 | 35 | 1. **name** 36 | 37 | > Name of your workflow 38 | 39 | 2. **on** 40 | 41 | > Control when the workflow will be triggerd 42 | 43 | 3. **jobs** 44 | 45 | > Deterimne one or more jobs / pipelines to run for the workflow, but you have to specifiy some parameters to run the job 46 | 47 | * **job_name** 48 | 49 | > Pick up your own job name 50 | 51 | * **runs_on** 52 | 53 | > Specify your runner type 54 | 55 | * **steps** 56 | 57 | > Represent a squence of tasks will be exceuted for each job / pipeline, each step have a some of parameters 58 | 59 | * **uses** 60 | 61 | > One of step parameters, you can use it when your are trying to install enviornment or repository from marketplace 62 | 63 | * **run** 64 | 65 | > One of step parameters, you can use it when your are trying to hit a command 66 | 67 | 68 | ### CI Sample :partying_face: 69 | 70 | This workflow run as a lint checker for each **Pushing** on master branch :rocket: 71 | 72 | ``` 73 | name: Build lint checker report 74 | 75 | on: 76 | push: 77 | branches: [ master ] 78 | 79 | jobs: 80 | lint: 81 | runs-on: ubuntu-latest 82 | steps: 83 | - name: Checkout 84 | uses: actions/checkout@v2 85 | 86 | - name: Setup Java JDK 87 | uses: actions/setup-java@v1 88 | with: 89 | java-version: 1.8 90 | 91 | - name: Build Lint 92 | run: ./gradlew lintDebug 93 | 94 | - name: Upload Build Lint Report 95 | uses: actions/upload-artifact@v2 96 | with: 97 | name: report 98 | path: app/build/reports/lint-results-debug.html 99 | ``` 100 | 101 | 102 | * [Checkout](https://github.com/marketplace/actions/checkout) : This action checks-out your repository under `$GITHUB_WORKSPACE`, so your workflow can access it. 103 | * [Setup Java JDK](https://github.com/marketplace/actions/setup-java-jdk) 104 | * Build Lint : Run lint report 105 | * [Upload Build Lint Report](https://github.com/marketplace/actions/upload-a-build-artifact) : This uploads artifacts from your workflow allowing you to share data between jobs and store data once a workflow is complete. 106 | 107 | 108 | ## Getting Started With CD ⚡ 109 | 110 | To get start with build CD pipelines, you should integrate your app with **Firebase Distribution**, then you could setup your workflow, please checkout [Firebase Distribution](https://firebase.google.com/docs/app-distribution) for more how to integrate your app with firebase :monocle_face: 111 | 112 | > Firebase App Distribution makes distributing your apps to trusted testers painless. By getting your apps onto testers' devices quickly, you can get feedback early and often. 113 | 114 | 115 | ### CD Sample :partying_face: 116 | 117 | This workflow builds a debug APK, then upload the artifact APK to a workflow dashboard and send another one to testers group on firebase distributions dashboard after each **Pull Request** on master branch 🚀 118 | 119 | ``` 120 | name: Integrate Firebase Distributions + Github Actions 121 | 122 | on: 123 | pull_request_target: 124 | branches: [ master ] 125 | 126 | jobs: 127 | builds: 128 | runs-on: ubuntu-latest 129 | steps: 130 | - name: Checkout 131 | uses: actions/checkout@v2 132 | 133 | - name: Setup Java JDK 134 | uses: actions/setup-java@v1 135 | with: 136 | java-version: 1.8 137 | 138 | - name: Build Gradle 139 | run: ./gradlew build 140 | 141 | - name: Upload a Build Artifact 142 | uses: actions/upload-artifact@v2 143 | with: 144 | name: app 145 | path: app/build/outputs/apk/debug/app-debug.apk 146 | 147 | - name: Upload Artifact To Firebase App Distribution 148 | uses: wzieba/Firebase-Distribution-Github-Action@v1.3.2 149 | with: 150 | appId: ${{ secrets.FIREBASE_ID }} 151 | token: ${{ secrets.FIREBASE_TOKEN }} 152 | groups: Android-CICD-Testers 153 | releaseNotes: "Hey! This my first integrate Firebase distributions with Github Actions" 154 | file: app/build/outputs/apk/debug/app-debug.apk 155 | ``` 156 | 157 | * Build Gradle : Build your APK. 158 | * [Upload Artifact To Firebase App Distribution](https://github.com/wzieba/Firebase-Distribution-Github-Action) : This action uploads artifacts (.apk,.aab) to Firebase App Distribution. 159 | * appId : Get it from your project settings on firebase console. 160 | * token : Run this command `firebase login:ci`, for more informations about how to get your firbase token, check out [Firebase CLI](https://firebase.google.com/docs/cli) 161 | 162 | > **Secrets** : This path to encrypt your sensitive information, you can access it from **Settings/Secrets Tab**, for more info checkout out [Encrypted Secrets](https://docs.github.com/en/actions/security-guides/encrypted-secrets) 163 | 164 | 165 | 166 | 167 | #### Screenshot from firebase distribution dashboard after sending the debug_app using Actions workflow 168 | ![Release](https://github.com/MohamedGElsharkawy/Android-CICD/blob/master/release_apk.png) 169 | 170 | ### [How to integrate your project wih sonarcloud code analysis](https://github.com/MohamedGElsharkawy/Android-CICD/blob/master/Sonar-Cloud.md) 171 | 172 | ## Contributing 173 | Don't hesitate to contribute with any updates or improves, just fork this repository, make the change you'd like and then submit a pull request. 174 | 175 | ## Issues 176 | Notice any issues with a repository? Please file a [Github Issue](https://github.com/MohamedGElsharkawy/Android-CICD/issues) in this repository. 177 | 178 | ## License 179 | 180 | ``` 181 | The MIT License (MIT) 182 | 183 | Copyright (c) 2021 MohamedGElsharkawy 184 | 185 | Permission is hereby granted, free of charge, to any person obtaining a copy 186 | of this software and associated documentation files (the "Software"), to deal 187 | in the Software without restriction, including without limitation the rights 188 | to use, copy, modify, merge, publish, distribute, sublicense, and/or sell 189 | copies of the Software, and to permit persons to whom the Software is 190 | furnished to do so, subject to the following conditions: 191 | 192 | The above copyright notice and this permission notice shall be included in 193 | all copies or substantial portions of the Software. 194 | 195 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR 196 | IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, 197 | FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE 198 | AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER 199 | LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, 200 | OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN 201 | THE SOFTWARE. 202 | ``` 203 | --------------------------------------------------------------------------------