Jenkins for android developer at TWJUG
2 likes585 views
This document discusses how to set up and use Jenkins for continuous integration and continuous delivery of Android applications. It covers installing Jenkins, setting up the first job, integrating with source control like Git, configuring Android tools, running tests, building and deploying to internal and production environments, reporting, notifications, and using Jenkins pipelines. The goal is to illustrate how Jenkins can be used to automate and simplify the mobile development process.
![WHAT’S NEXT
Jenkin
stage('Preparation') {
steps {
checkout(
[$class : 'GitSCM',
branches : [[name: '*/internal']],
userRemoteConfigs : [[credentialsId: ‘credential_id', url: ‘repo_url’]]
])
}
}](https://image.slidesharecdn.com/jenkinsforandroiddeveloperattwjug-180326021214/85/Jenkins-for-android-developer-at-TWJUG-39-320.jpg)
![WHAT’S NEXT
Jenkin
stage('Test') {
steps {
script {
try {
sh './gradlew test'
} finally {
publishHTML([allowMissing: false, alwaysLinkToLastBuild: false, keepAll: false, reportDir: ‘repo_dir',
reportFiles: 'index.html', reportName: 'Unit Test Report', reportTitles: ''])
}
}
}
}](https://image.slidesharecdn.com/jenkinsforandroiddeveloperattwjug-180326021214/85/Jenkins-for-android-developer-at-TWJUG-40-320.jpg)
![WHAT’S NEXT
Jenkin
stage('Deploy') {
steps {
parallel(
alpha: {
step([
$class : 'FabricBetaPublisher',
apiKey : “api_key",
apkPath : "app/build/outputs/apk/debug/*.apk",
buildSecret : “build_secret",
notifyTestersType : 'NOTIFY_TESTERS_GROUP',
releaseNotesType : 'RELEASE_NOTES_FROM_CHANGELOG',
testersGroup : "internal",
organization : "pklotcorp",
useAntStyleInclude: true
])
},
production: {
step([])
}
)
}
}](https://image.slidesharecdn.com/jenkinsforandroiddeveloperattwjug-180326021214/85/Jenkins-for-android-developer-at-TWJUG-42-320.jpg)
![WHAT’S NEXT
Jenkin
stage('Analytics') {
steps {
sh './gradlew lint'
publishHTML([allowMissing: false, alwaysLinkToLastBuild: false, keepAll: false, reportDir: 'app/build/reports',
reportFiles: 'lint-results.html', reportName: 'Lint Error Report', reportTitles: ''])
withSonarQubeEnv('SonarQube') {
sh './gradlew clean createDebugCoverageReport jacocoTestReport --info sonarqube'
}
}
}](https://image.slidesharecdn.com/jenkinsforandroiddeveloperattwjug-180326021214/85/Jenkins-for-android-developer-at-TWJUG-43-320.jpg)
Jenkins for android developer at TWJUG
- 1. ⾃自⼰己的 Jenkins ⾃自⼰己來來 For Android Developer Andyang@Twjug X
- 2. AGENDA ▸ What Jenkins ▸ Why Jenkins ▸ Workflow ▸ Install Jenkins ▸ First Job ▸ Integration with SCM ▸ Set up with Android ▸ Run Test ▸ Build ▸ Deploy to internal/production EVN ▸ Reporting ▸ Notify to slack ▸ What’s next? ▸ Jenkins pipeline
- 6. WHAT JENKINS ▸ Open source written in Java ▸ CI ▸ build ▸ test ▸ source code analysis ▸ CD ▸ delivery/deploy ▸ deploy to staging/production
- 7. WHY JENKINS ▸ 懶懶 ▸ 懶懶 ▸ 懶懶 ▸ 可重複執⾏行行 (Repeatable) ▸ ⾃自動化 (Automation) ▸ 定期執⾏行行 (cron job) ▸ 各種 web hook ▸ 基於以上幾點就可以很懶懶但不容易易出錯 (應該拉？！
- 9. INSTALL JENKINS ▸ Using war ▸ download jenkins war ▸ java -jar jenkins.war --httpPort=8080 ▸ open browser http://localhost:8080
- 10. INSTALL JENKINS ▸ Install on Server (Ubuntu) ▸ sudo apt-get update ▸ sudo apt-get install jenkins ▸ vim /etc/default/jenkins ▸ HTTP_PORT=8080 ▸ sudo systemctl start/stop/status jenkins ▸ open browser http://lp_address_or_domain:8080
- 11. INSTALL JENKINS ▸ unlock jenkins ▸ Install suggested plugins ▸ setting admin user
- 12. INSTALL JENKINS ▸ Install on Windows ▸ 下載安裝檔 ▸ 下⼀一步 -> 下⼀一步 -> 下⼀一步 … 完成！ ▸ 需要注意之處： ▸ Shell script 改寫成 DOS 使⽤用的 Batch script ▸ Job 名稱不能為中⽂文，否則執⾏行行 Batch script 會卡住 ▸ Workspace 路路徑太長會造成 Gradle task 出現錯誤
- 13. FIRST JOB ▸ Free style ▸ pipeline ▸ Others…..
- 14. INTEGRATION WITH SCM ▸ Git/Mercurial/SVN ▸ Git ▸ repo url ▸ Credentials ▸ Branch ▸ Additional behaviors (只列列我有⽤用的) ▸ sub module
- 15. JENKINS CREDENTIALS ▸ Credentials -> global -> add credentials ▸ Credentials type ▸ user name & password ▸ ssh ▸ others ▸ ssh ▸ generate ssh key ▸ set user name ▸ set private key path ▸ set passphrase ▸ upload ssh public key to git server
- 16. INTEGRATION WITH GITHUB WEB HOOK ▸ Jenkins -> 管理理 Jenkins -> 管理理外掛程式 ▸ 可⽤用的 -> Github Integration Plugin 勾選安裝 ▸ 建置觸發程序 GitHub hook trigger for GITScm polling 勾選 ▸ GitHub repo -> setting -> integration services ▸ add service -> Jenkins (Github plugin) ▸ set up jenkins web hook path https://jenkins_domain_name/github_webhook/ ▸ active 勾選 ▸ 如何驗證測試 ▸ push commit 到指定的 branch ▸ 在 job 選單點選 Github Hook Log
- 17. SET UP WITH ANDROID ▸ Set up Java ▸ 管理理 Jenkins -> Global Tool Configuration
- 18. SET UP WITH ANDROID ▸ Set up gradle ▸ 管理理 Jenkins -> Global Tool Configuration
- 19. SET UP WITH ANDROID ▸ Run gradle script ▸ 建置 -> Invoke Gradle Script ▸ 能⽤用的 task 有哪些 ./gradlew tasks
- 20. SET UP WITH ANDROID ▸ Set up ANDROID_HOME ▸ 管理理 Jenkins -> 設定系統 ▸ 環境變數 ANDROID_HOME
- 21. RUN TEST ▸ Unit test report ▸ https://jenkins_url/job/job_name/report_path/ index.html
- 22. BUILD
- 23. DEPLOYMENT ▸ Fabric beta (internal for QA) ▸ jenkins plugins -> Fabric Beta Publisher ▸ beta api key / build secret ▸ APK path ▸ Notify tester ▸ Beta Group ▸ Release ▸ change log ▸ file ▸ parameter ▸ Google play (for production)
- 24. DEPLOYMENT ▸ Google play (for production) ▸ 需要 google play 的 owner 帳號設定 ▸ generate credentials ▸ google play console -> api 存取權 (owner) ▸ download credentials json file ▸ create google console user by json file client_email ▸ 權限設定為發佈者
- 25. DEPLOYMENT ▸ Google play (for production) ▸ Install jenkins plugin -> Google Play Android Publisher Plugin
- 27. REPORTING ▸ Unit Test Report
- 28. REPORTING ▸ Unit Test Report
- 29. REPORTING - SONARQUBE ▸ 程式碼品質分析⼯工具 ▸ ⽀支援 20+ 程式語⾔言 ▸ Open Source
- 30. REPORTING - SONARQUBE ▸ Bugs ▸ Code smells
- 31. REPORTING - SONARQUBE ▸ Coverage ▸ Duplications
- 32. NOTIFY TO SLACK ▸ Install jenkins plugin -> Global Slack Notifier Plugin
- 33. NOTIFY TO SLACK（ADVANCED） ▸ 客製化訊息
- 34. NOTIFY TO SLACK（ADVANCED） ▸ Slack Message Builder
- 35. ENVIRONMENT VARIABLES ▸ Jenkins 提供環境變數 ▸ 整合專案 …下略略
- 36. ENVIRONMENT VARIABLES ▸ Gradle 設定 android { …… defaultConfig { …… versionCode System.getenv("BUILD_NUMBER") as Integer ?: 0 …… } }
- 37. WHAT’S NEXT ▸ Jenkins pipeline ▸ configuration as code
- 39. WHAT’S NEXT Jenkin stage('Preparation') { steps { checkout( [$class : 'GitSCM', branches : [[name: '*/internal']], userRemoteConfigs : [[credentialsId: ‘credential_id', url: ‘repo_url’]] ]) } }
- 40. WHAT’S NEXT Jenkin stage('Test') { steps { script { try { sh './gradlew test' } finally { publishHTML([allowMissing: false, alwaysLinkToLastBuild: false, keepAll: false, reportDir: ‘repo_dir', reportFiles: 'index.html', reportName: 'Unit Test Report', reportTitles: '']) } } } }
- 41. WHAT’S NEXT Jenkin stage('Build') { steps { parallel( alpha: { sh './gradlew assembleDebug' }, production: { sh './gradlew assembleRelease' } ) } }
- 42. WHAT’S NEXT Jenkin stage('Deploy') { steps { parallel( alpha: { step([ $class : 'FabricBetaPublisher', apiKey : “api_key", apkPath : "app/build/outputs/apk/debug/*.apk", buildSecret : “build_secret", notifyTestersType : 'NOTIFY_TESTERS_GROUP', releaseNotesType : 'RELEASE_NOTES_FROM_CHANGELOG', testersGroup : "internal", organization : "pklotcorp", useAntStyleInclude: true ]) }, production: { step([]) } ) } }
- 43. WHAT’S NEXT Jenkin stage('Analytics') { steps { sh './gradlew lint' publishHTML([allowMissing: false, alwaysLinkToLastBuild: false, keepAll: false, reportDir: 'app/build/reports', reportFiles: 'lint-results.html', reportName: 'Lint Error Report', reportTitles: '']) withSonarQubeEnv('SonarQube') { sh './gradlew clean createDebugCoverageReport jacocoTestReport --info sonarqube' } } }
- 44. WHAT’S NEXT Jenkin post { success { sh 'curl -X POST // see slack api format’ } failure { sh '' } }
- 45. Q&A
- 46. REFERENCES ▸ Jenkins Environment Variables: https://goo.gl/ 6R5tGi ▸ Slack Message Builder: https://goo.gl/0uKyN5 ▸ SonarQube plugin for Kotlin: https://goo.gl/tA8v3F ▸ Install Jenkins on Ubuntu ▸ Jenkins 官網