Written by chuotfx on September 16, 2019

Trigger build iOS Application với Travis CI

Contents

Mọi thứ đã hoạt động một cách trơn tru rồi nhưng để thực sự thông minh hơn và tiện lợi hơn thì máy CI sẽ tự động build đúng theo cấu hình tương ứng với với những cài đặt của mình. Và đây cũng làm phần cuối trong seri mệt mỏi này.

1. Bài toán đặt ra

a) khi merge 1 pull request vào nhánh develop thì build môi trường dev gởi QCs 1 bản thông qua fabric
b) khi merge develop vào master thì tự động build môi trường stag gởi PMs
c) khi tạo branch release/* (ví dụ release/build) thì sẽ tự động build 1 bản production file *.ipa để đó, không up lên đâu hết.
(Các nhóm QCs, Pms được tạo trong Fabric)

1.1. Phân tích yêu cầu

- Cần 3 bản build với 3 cấu hình khác nhau
  - Dev
  - Staging
  - Product
- Theo dõi các hoạt động của GitHub bằng CI
  - Pull Request
  - Commit
  - Push Branch
- Phân tích xác định được các tên Branch
  - master cho Staging
  - develop cho Dev
  - release/* cho Product

1.2. Các công việc chúng ta cần làm

- Cấu hình lại project và lane để build được theo các config (đã tạo ở phần này)
  - Dev
  - Staging
  - Release
- Bắt được các trigger của Travis CI để chon lên build fastlane tương ứng
- Code xử lý các trigger đó

2. Cấu hình Project và Fastlane

2.1. Project

Về project trong Xcode thì bạn cần tuỳ chỉnh lại các cấu hình
- Develop : auto signing để build
- Staging : thì build manual, Xcode sẽ tự chọn cấu hình tương ứng trong Certificate và Provisioning
- Release : tương tự như Staging
Với phần 1 thì mình mới chỉ hướng dẫn mỗi 1 việc tạo các file Config để cấu hình chứa chưa đi vào hướng dẫn cấu hình từng cái như thế nào. Sau đây là cấu hình đề nghị cho mọi người có thể dễ làm theo.

Giải thích
- Debug thì sẽ là auto theo iOS Developer, certificate và provisioning sẽ tự nhận theo config trong Xcode
- Staging thì sẽ là manual cho iOS Distribution, chỉ định rõ provisioning AdHoc. Còn certificatie sẽ được import từ ngoài vào máy MAC OS
  - Trên máy local là kích bằng tay và nó sẽ vào Keychain
  - Trên máy Travis thì mình dùng lệnh để import vào máy thông qua Keychain tự tạo
- Release thì tương tư Staging, hoặc có thể cấu hình khác một chút nếu khách hàng muốn build cho AppStore…

2.2. Fastlane

Trước tiên chúng ta cần test lại các cấu hình ở local để xem fastlane hoạt đồng hiệu quả hay không.
Chú ý:
- scheme
- configuration
- export_method (tham khảo sau)
  - app-store
  - ad-hoc
  - package
  - enterprise
  - development
  - developer-id

desc "Build App AdHoc Local"
  lane :build_adhoc_local do
    make_build_folder
    build_ios_app(
      scheme: "TheLastProject_Staging", 
      workspace: "TheLastProject.xcworkspace",
      configuration: "Staging", 
      export_method: "ad-hoc",
      output_directory: "./build",
      output_name: "TheLastProject_Staging.ipa",
      silent: true,
      clean: true
    )
  end

Tiến hành build chạy trên local và tận hưởng kết quả. Nếu gặp lỗi thì bạn hãy bình tỉnh và xem lại các config trong Xcode và edit lại cho đúng.

bundle exec fastlane build_adhoc_local

Cần chú ý là bạn phải import các cetificate (development & distribution) vào máy trước đã. Nếu Terminal chạy ra như thế này thì fastlane đã chọn đúng cấu hình.

Áp dụng cho các config còn lại
Fastlane cho build trên máy CI, tham khảo 2 đoạn code sau và chú ý các config để sao cho đúng
- Build Staging

desc "Build Staging"
  lane :build_staging do
    make_build_folder
    disable_automatic_code_signing(
      path: "TheLastProject.xcodeproj"
    )
    import_certificate(
      keychain_name: "ios-build.keychain",
      keychain_password: ENV["KEYCHAIN_PASS"],
      certificate_path: "./scripts/certs/dis.p12",
      certificate_password: ENV["CERT_PASS"]
    )
    update_project_provisioning(
      xcodeproj: "TheLastProject.xcodeproj",
      profile: "./scripts/profiles/TheLastProject_AdHoc.mobileprovision",
      target_filter: "TheLastProject",
      build_configuration: "Staging",
    )
    build_ios_app(
      scheme: "TheLastProject_Staging", 
      workspace: "TheLastProject.xcworkspace",
      configuration: "Staging", 
      export_method: "ad-hoc",
      output_directory: "./build",
      silent: true,
      clean: true,
      skip_profile_detection: true,
      export_options: {
        provisioningProfiles: { "com.fx.thelastproject": "TheLastProject_AdHoc" }
      }
    )
    create_release_notes(format: 'Appstore: %h %s')
    upload_fabric(groups: "staging")
    enable_automatic_code_signing(
      path: "TheLastProject.xcodeproj"
    )
  end

- Build Release

desc "Build Release"
  lane :build_release do
    make_build_folder
    disable_automatic_code_signing(
      path: "TheLastProject.xcodeproj"
    )
    import_certificate(
      keychain_name: "ios-build.keychain",
      keychain_password: ENV["KEYCHAIN_PASS"],
      certificate_path: "./scripts/certs/dis.p12",
      certificate_password: ENV["CERT_PASS"]
    )
    update_project_provisioning(
      xcodeproj: "TheLastProject.xcodeproj",
      profile: "./scripts/profiles/TheLastProject_AdHoc.mobileprovision",
      target_filter: "TheLastProject",
      build_configuration: "Release",
    )
    build_ios_app(
      scheme: "TheLastProject_Release", 
      workspace: "TheLastProject.xcworkspace",
      configuration: "Release", 
      export_method: "ad-hoc",
      output_directory: "./build",
      silent: true,
      clean: true,
      skip_profile_detection: true,
      export_options: {
        provisioningProfiles: { "com.fx.thelastproject": "TheLastProject_AdHoc" }
      }
    )
    create_release_notes(format: 'Appstore: %h %s')
    upload_fabric(groups: "release")
    enable_automatic_code_signing(
      path: "TheLastProject.xcodeproj"
    )
  end

Nếu kết quả chạy trên máy CI không được đúng như mong muốn thì cần bình tĩnh lại. Giải quyết từng lỗi một. Khi mọi thứ hoàn hảo thì mới tiến hành sang bước tiếp theo được.

3. Trigger

Muốn cho máy CI có thể chọn đúng cấu hình để build thì chúng ta cần phải bắt được và xử lý được các thông tin sau:

- Tên branch
- Kiểu tương tác
  - Commit
  - Push
  - Pull Request
  - Merge

Các thông tin đó thì Travis đã hỗ trợ bạn trong các biến môi trường (environment-variables) của nó. Đọc thêm tại đây.
Kiểm tra các config trong setting của Travis đã ổn chưa
- Build pushed branches : on
- Build pushed pull requests : on
Thử với việc kiểm tra các pull request đúng với 2 branch
- develop thì sẽ build cho môi trường Dev
- master thì sẽ build cho môi trường Staging
Mở file .travis.yml và edit đoạn script sau:

script:
  - ./scripts/lint
  - if [[ "$TRAVIS_BRANCH" == "develop" ]]; then bundle exec fastlane build_dev; fi

Tạo branch develop commit code và tận hưởng cái kết.
Giải thích
- Đoạn script trên:
  - Sử dụng biến muôi trường
  - Vài dòng if else cơ bản
  - Bạn có thể sử dụng cho master

Tuy nhiên, với việc build cho môi trường Release thì có yêu cầu là khi tạo 1 branch với tên là release/* thì Travis sẽ tự động chạy và build. Công việc chúng ta còn 2 việc
- Lấy đúng tên branch
- Xử lý chuỗi để biết là có chữ release hay không
- Tham khảo : https://stackoverflow.com/questions/2172352/in-bash-how-can-i-check-if-a-string-begins-with-some-value

Bash cách bá hơn để lấy được tên branch hiện tại.

script:
  - export BRANCH=$(if [ "$TRAVIS_PULL_REQUEST" == "false" ]; then echo $TRAVIS_BRANCH; else echo $TRAVIS_PULL_REQUEST_BRANCH; fi)
  - echo "TRAVIS_BRANCH=$TRAVIS_BRANCH, PR=$PR, BRANCH=$BRANCH"

Sau khi đủ các điều kiện và biến thì bạn hãy viết 1 script riêng cho việc build app này. Đây là đoạn code tham khảo, mình tạo file shell bash với tên là run
- Lấy được current branch
- Xử lý đc chuỗi
- Khuyên bạn là nên test đoạn script này ở local (xoá các dòng lệnh build, để lại lệnh echo)

#Log debug branch
BRANCH=$(if [ "$TRAVIS_PULL_REQUEST" == "false" ]; then echo $TRAVIS_BRANCH; else echo $TRAVIS_PULL_REQUEST_BRANCH; fi)
echo "TRAVIS_BRANCH=$TRAVIS_BRANCH, PR=$PR, BRANCH=$BRANCH"

if [ "$TRAVIS_BRANCH" == "develop" ]
then
  echo "********** BUILD DEV **********"
  bundle exec fastlane build_dev
elif [ "$TRAVIS_BRANCH" == "master" ]
then
  echo "********** BUILD STAGING **********"
  bundle exec fastlane build_staging
elif [[ "$TRAVIS_BRANCH" == "release"* ]]
then
  echo "********** BUILD RELEASE **********"
  bundle exec fastlane build_release
else
  echo "NOTHING"
fi

Sau khi đã OK thì bạn commit code và tiến hành test theo các trường hợp mà yêu cầu đề ra
- Tạo branch develop , tạo tiếp branch con từ nó, edit và gởi pull request
- Merge develop về master
- Tạo branch release/* từ master
Bạn kiểm tra các bản build đã được upload lên Fabric hay chưa. Nếu còn lỗi thì hãy fix nó. Nếu oke hết thì chúc mừng bạn đã hoàn thành seri mệt mỏi này
Phần tiếp theo mà bạn cần làm
- Làm đẹp code
- Build matrix
- Config với các dịch vụ CI khác

Tổng kết

Cấu hình để fastlane build được với các config khác nhau của iOS Project
Tạo các trigger để có Travis CI biết lúc nào nên build cho môi trường nào
Cấu hình cho CI tự động build và gởi cho các môi trường tương ứng.

Facebook Tweet Pin Yummly LinkedIn Print EmailShares4

Written by chuotfx

Hãy ngồi xuống, uống miếng bánh và ăn miếng trà. Chúng ta cùng nhau đàm đạo về đời, về code nhóe!

Trigger build iOS Application với Travis CI

1. Bài toán đặt ra

1.1. Phân tích yêu cầu

1.2. Các công việc chúng ta cần làm

2. Cấu hình Project và Fastlane

2.1. Project

2.2. Fastlane

3. Trigger

Tổng kết

Related Posts:

Written by chuotfx

Leave a Reply Cancel reply

Donate – Buy me a coffee!

Fan page

Recent Posts

You may also like:

Archives

About me

Trigger build iOS Application với Travis CI

1. Bài toán đặt ra

1.1. Phân tích yêu cầu

1.2. Các công việc chúng ta cần làm

2. Cấu hình Project và Fastlane

2.1. Project

2.2. Fastlane

3. Trigger

Tổng kết

Related Posts:

Written by chuotfx

Leave a Reply Cancel reply

Donate – Buy me a coffee!

Fan page

Tags

Recent Posts

You may also like:

Archives