{"id":63278,"date":"2024-08-14T11:50:13","date_gmt":"2024-08-14T06:20:13","guid":{"rendered":"https:\/\/2thenew.online\/blog\/?p=63278"},"modified":"2024-08-14T12:29:53","modified_gmt":"2024-08-14T06:59:53","slug":"ios-ci-cd-integration-using-gitlab-fastlane-firebase-part-1-page-2","status":"publish","type":"post","link":"https:\/\/2thenew.online\/blog\/ios-ci-cd-integration-using-gitlab-fastlane-firebase-part-1-page-2\/","title":{"rendered":"iOS: CI\/CD Integration via FastLane & Firebase using Gitlab : Part \u2013 2"},"content":{"rendered":"

In the first part of the blog<\/a>, we covered the Fastlane setup\/Installation with multiple files like Appfile, Gymfile, and Fastfile. Now we are moving to the next part of this series where we will use CI\/CD workflow via Fastlane & Firebase on the local machine.<\/p>\n

We will use the next step of the Code Signing approach via the match import <\/em><\/strong>command. This will create a separate repository and upload your private keys and certificates in a Gitlab repo for syncing them across the machines. This approach is secure<\/a>.<\/p>\n

Code Signing approach:\u00a0 <\/b>Using Fastlane <\/b>match<\/b><\/a><\/p>\n

The concept of <\/span>match<\/span><\/i><\/a> command is described in the <\/span>codesigning guide<\/span><\/a>.<\/span><\/p>\n

Import: Prepare Certificates Using Match(Only one-time setup)<\/b><\/h2>\n

To import and encrypt a certificate (<\/em><\/span>.cer<\/span><\/em>)<\/em>, the private key (<\/em><\/span>.p12<\/span><\/em>),<\/em> and the provisioning profiles (<\/em><\/span>.mobileprovision<\/span> or <\/span>.provisionprofile<\/span><\/em>)<\/em> into the <\/span>match<\/span><\/i> repo run:<\/span><\/p>\n

\r\n$ fastlane match import\r\n<\/strong><\/span>\r\n<\/pre>\n
You will be prompted for the certificate (<\/span>.cer<\/span>), the private key (<\/span>.p12<\/span>), and the provisioning profiles (<\/span>.mobileprovision<\/span> or <\/span>.provisionprofile<\/span>) paths. <\/span>match<\/span><\/i> will first validate the certificate (<\/span>.cer<\/span>) against the Developer Portal before importing the certificate, the private key, and the provisioning profiles into the specified <\/span>match<\/strong><\/em> repository.<\/span><\/p>\n
However, if there is no access to the developer portal but there are certificates, private keys, and profiles provided, you can use the <\/span>skip_certificate_matching<\/em><\/strong> option to tell <\/span>match<\/i><\/strong> not to verify the certificates. Like this:<\/span><\/p>\n
\r\n$ fastlane match import --skip_certificate_matching true\r\n<\/strong><\/span>\r\n<\/pre>\n
The default type is \u2018<\/span>development<\/strong><\/em>\u2019. So we need to specify the type explicitly.<\/span><\/p>\n
\r\n$ fastlane match import --type enterprise --skip_certificate_matching true\r\n\r\n<\/strong><\/span><\/pre>\n
This step will skip login to the Apple Developer Portal and will import the provided certificate, private key, and profile directly to the certificates Gitlab repo.<\/span><\/p>\n
We need to be careful when using this option and ensure the certificates and profiles match the type (development, adhoc, appstore, enterprise, developer_id) and are not revoked or expired.\u00a0<\/span><\/p>\n
4. Matchfile- <\/b>Please follow the steps while initializing the match<\/strong> command with prompted options.<\/p>\n
Step-1. <\/strong>Initialize Match in your iOS project by running the command <\/span>fastlane match init <\/strong><\/em>in the root directory of your project.<\/span><\/p>\n
\"null\"<\/p>\n
Step-2<\/strong>. Fastlane Match supports multiple storage modes and will ask you to select the one you want to use like options <\/span>1, 2, and so on. <\/b>In this blog, We have selected option 1 which is ‘git<\/strong>‘.<\/p>\n
Step-3<\/strong>. The system will ask you for the URL of the Git Repo t<\/span>hen Enter the <\/span>EMPTY GIT-CETIFICATE URL (it’s added on prerequisites new to provide a separate shared repository ).<\/i><\/b><\/p>\n
\r\n git_url<\/span>(\"EMPTY GIT-CETIFICATE Repoistory\")\r\n storage_mode<\/span>(\"git\")\r\n type<\/span>(\"enterprise\") # The default type, can be: appstore, adhoc, enterprise or development\r\n ENV[\"MATCH_PASSWORD\"<\/span>] = \"MATCH_PASSWORD\"<\/span>\r\n\r\n<\/strong><\/span><\/pre>\n
Setup Fastfile actions-<\/b> In the Fastlfile Actions, We will set up all the actions like custom variables, and lanes to execute the set of tasks in a sequential manner.<\/span><\/p>\n
\r\n# This file contains the fastlane.tools configuration\r\n# You can find the documentation at https:\/\/docs.fastlane.tools\r\n#\r\n# For a list of all available actions, check out\r\n#\r\n#     https:\/\/docs.fastlane.tools\/actions\r\n#\r\n# For a list of all available plugins, check out\r\n#\r\n#     https:\/\/docs.fastlane.tools\/plugins\/available-plugins\r\n#\r\n\r\n# Uncomment the line if you want fastlane to automatically update itself\r\n# update_fastlane\r\n\r\n#Variables\r\nAPP_BUNDLE_ID = \"com.test.iOS\"\r\n#APP_BUNDLE_ID_NSE = \"com.test.iOS.Todo_ios-NSE\"\r\n#APP_BUNDLE_ID_NCE = \"com.test.iOS.Todo_ios-NCE\"\r\n\r\nAPP_PROVISION_TITLE = \"AdhocDistribution\"\r\n#APP_PROVISION_TITLE_NSE = \"Todo_ios Adhoc NSE\"\r\n#APP_PROVISION_TITLE_NCE = \"Todo_ios Adhoc NCE\"\r\n\r\n#App Method support list\r\n#[\"app-store\", \"validation\", \"ad-hoc\", \"package\", \"enterprise\", \"development\", \"developer-id\", \"mac-application\"]\r\nAPP_METHOD = \"enterprise\"\r\n\r\n# The default type, can be: appstore, adhoc, enterprise or development\r\nMATCH_METHOD = \"enterprise\"\r\n\r\nPROJECT_SCHEMA_QA = 'Todo_ios'\r\nPROJECT_WORKSPACE = 'Todo_ios.xcworkspace'\r\nPROJECT_XCODEPROJ = 'Todo_ios.xcodeproj'\r\nIPA_FILE_NAME = \"Todo_ios\"\r\nBUILD_PATH = \".\/builds\"\r\nINCLUDE_BITCODE = false\r\nINCLUDE_SYMBOLS = false\r\n\r\nFIREBASE_APP_ID = \"FIREBASE_APP_ID\"# i.e, \"1:58453............\"\r\nTESTER_LIST = \"test@gmail.com\" # Add with coma separated\r\nRELEASE_NOTES_FILE_PATH = \".\/fastlane\/release-notes.txt\"\r\n\r\nMY_TEAM = \"MY_TEAM\" # i.e, \"RT......\"\r\n\r\nGIT_URL_CERTIFICATES = \"GIT_URL_CERTIFICATES\"# i.e, \"https:.........\/todo_ios_certificate\"\r\n\r\n#Fetch values from environmental variables\r\nusername = ENV['USERNAME']\r\npersonal_github_access_token = \"PERSONAL_GITHUB_ACCESS_TOKEN\" # i.e, \"gl..........\"\r\nauthorization_token_str = \"#{username}:#{personal_github_access_token}\"\r\nbasic_authorization_token = Base64.strict_encode64(authorization_token_str)\r\n\r\n#Key chain passcode of MacOS machine\r\nKEYCHAIN_PASSWORD = \"KEYCHAIN_PASSWORD\" # i.e, \"Raj.........\"\r\n\r\ndefault_platform(:ios)\r\n\r\nplatform :ios do\r\n\r\n desc \"Sync certificates\"\r\n  lane :sync_certificates do\r\n   #read-only disables match from overriding the existing certificates.\r\n   match(type: MATCH_METHOD,\r\n    app_identifier: APP_BUNDLE_ID,\r\n    git_url: GIT_URL_CERTIFICATES,\r\n    git_basic_authorization: basic_authorization_token,\r\n    keychain_password: KEYCHAIN_PASSWORD,\r\n    readonly: true,\r\n    skip_certificate_matching: true,\r\n    verbose: true)\r\n\r\n end\r\n \r\n \r\ndesc \"Update project provisioning\"\r\n lane :update_provisioning do\r\n     \r\n    CERTIFICATE_NAME = ENV[\"sigh_#{APP_BUNDLE_ID}_#{MATCH_METHOD}_certificate-name\"]\r\n    APP_PROVISION_PROFILE_PATH = ENV[\"sigh_#{APP_BUNDLE_ID}_#{MATCH_METHOD}_profile-path\"]\r\n     \r\n    update_project_provisioning(\r\n    xcodeproj: PROJECT_XCODEPROJ,\r\n    profile: APP_PROVISION_PROFILE_PATH,\r\n    build_configuration: \"QA\",\r\n    code_signing_identity: CERTIFICATE_NAME\r\n    )\r\n\r\n end\r\n \r\ndesc \"Disable automatic code signing\"\r\n lane :disable_auto_code_sign do\r\n    # more advanced manual code signing\r\n    update_code_signing_settings(\r\n    use_automatic_signing: false,\r\n    path: \".\/#{PROJECT_XCODEPROJ}\",\r\n    team_id: MY_TEAM,\r\n    bundle_identifier: APP_BUNDLE_ID,\r\n    code_sign_identity: \"\",\r\n    profile_name: \"\"\r\n    )\r\n end\r\n     \r\n \r\n \r\ndesc \"QA Build\"\r\n  lane :qa_build do\r\n  \r\n    APP_PROVISION_PROFILE_NAME = ENV[\"sigh_#{APP_BUNDLE_ID}_#{MATCH_METHOD}_profile-name\"]\r\n    #EXPORT_TEAM_ID  = ENV[\"sigh_#{APP_BUNDLE_ID}_#{MATCH_METHOD}_team-id\"]\r\n        \r\n    gym(scheme: PROJECT_SCHEMA_QA,\r\n    workspace: PROJECT_WORKSPACE,\r\n    clean: true,\r\n    silent: false,\r\n    include_bitcode: INCLUDE_BITCODE,\r\n    include_symbols: INCLUDE_SYMBOLS,\r\n    xcargs: {\r\n        BUNDLE_IDENTIFIER: APP_BUNDLE_ID,\r\n        #PROVISIONING_PROFILE_SPECIFIER: APP_PROVISION_PROFILE_NAME,\r\n        DEVELOPMENT_TEAM: MY_TEAM,\r\n        CODE_SIGN_STYLE: \"Manual\"\r\n    },\r\n    export_xcargs: \"-allowProvisioningUpdates\",\r\n    skip_profile_detection: true,\r\n    export_options: {\r\n        method: APP_METHOD,\r\n        provisioningProfiles: {\r\n         APP_BUNDLE_ID => APP_PROVISION_TITLE,\r\n        }\r\n    },\r\n    configuration: 'Release',\r\n    output_name: IPA_FILE_NAME,\r\n    output_directory:BUILD_PATH,\r\n    skip_codesigning: false,\r\n    #export_team_id: EXPORT_TEAM_ID,\r\n    verbose: true)\r\n  end\r\n  \r\n  \r\ndesc \"Increament build version\"\r\n  lane :increment_version do\r\n    LATEST_VERSION = 0\r\n  latest_release = firebase_app_distribution_get_latest_release(\r\n    app: FIREBASE_APP_ID\r\n  )\r\n  \r\n  if latest_release != nil\r\n    LATEST_VERSION = latest_release[:buildVersion].to_i\r\n  end\r\n  increment_build_number({ build_number: LATEST_VERSION + 1 })\r\nend\r\n    \r\ndesc \"clean\"\r\n  lane :clean do\r\n    clear_derived_data(derived_data_path: BUILD_PATH)\r\n  end\r\n  \r\ndesc \"Create ipa\"\r\n  lane :build do\r\n    #clean derived data for path\r\n    clean\r\n    \r\n    # Disable automatic code signing\r\n    #disable_auto_code_sign\r\n    \r\n    #match certificate & profile\r\n    sync_certificates\r\n    \r\n    #update project provisioning\r\n    #update_provisioning\r\n    \r\n    # Creates a signed file\r\n    qa_build\r\n end\r\nend\r\n<\/strong><\/span><\/pre>\n
Note: Please update your own detail in the above script i.e,.<\/p>\n
APP_BUNDLE_ID,<\/p>\n
APP_PROVISION_TITLE,<\/p>\n
FIREBASE_APP_ID,<\/p>\n
TESTER_LIST,<\/p>\n
MY_TEAM,<\/p>\n
GIT_URL_CERTIFICATES,<\/p>\n
PERSONAL_GITHUB_ACCESS_TOKEN,<\/p>\n
KEYCHAIN_PASSWORD.<\/p>\n
Now run <\/span>fastlane ios build<\/i><\/b> command,\u00a0<\/span><\/p>\n
Result:-<\/strong> The above command will generate the .ipa file using above configuration setup with the fastlane summary.\u00a0\u00a0<\/span><\/p>\n
\"null\"<\/p>\n
Trouble Shoot:-<\/b><\/h2>\n
    \n
  1. \n
      \n
    1. Validate Bundle Identifiers on FastFile.<\/span><\/li>\n
    2. Validate that Schema and Project names are Proper.<\/span><\/li>\n
    3. Make Sure You have disabled automatic Sign-in and manually add profiles.<\/span><\/li>\n
    4. Make sure that your iOS project is properly set up Locally on Xcode and you are able to archive and export to the app store by disabling automatic signing.
      \n<\/span><\/li>\n<\/ol>\n<\/li>\n<\/ol>\n
      Upload to firebase<\/b><\/h1>\n
      Next, you need to set up the Firebase App Distribution plugin. This tool allows you to upload to Firebase from Fastlane with an action. <\/span>From the Terminal, run the following command to add the App Distribution plugin to your Fastlane installation:<\/span><\/p>\n
      \r\n$ fastlane add_plugin firebase_app_distribution\r\n\r\n<\/strong><\/span><\/pre>\n
      \"null\"<\/p>\n
      If for some reason, plugins are not installed, try again after disabling the VPN.<\/span><\/p>\n
      The next step is to log in to Firebase. Follow the steps mentioned on the website.<\/b><\/p>\n
        https:\/\/firebase.google.com\/docs\/cli<\/a>\r\n<\/strong><\/pre>\n
      Now open Fastfile in a text editor, and paste the code below fastlane lane:<\/span>
      \n      \"null\"<\/a><\/p>\n
       \r\ndesc \"Upload build to Firebase\" \r\n  lane :upload_build_to_firebase do \r\n  firebase_app_distribution( \r\n  ipa_path: \"#{BUILD_PATH}\/#{IPA_FILE_NAME}.ipa\", \r\n  app: FIREBASE_APP_ID, testers: TESTER_LIST, \r\n  #groups: \"\", \r\n  #release_notes_file: RELEASE_NOTES_FILE_PATH, \r\n  release_notes: \"Testing build upload\") \r\nend\r\n<\/strong><\/span><\/pre>\n
      Also, add the code below the fastlane build<\/em><\/strong> lane
      \n      \"null\"<\/a><\/p>\n
       \r\ndesc \"Create ipa\"\r\n............\r\n......\r\n\r\n# Increases the build number by 1 \r\n#increment_version\r\n \r\n# Creates a signed file \r\nqa_build \r\n\r\n# Build upload to firebase \r\nupload_build_to_firebase\r\n\r\nend<\/strong><\/span><\/pre>\n
       <\/p>\n
      After all these setups, run the following command from Terminal: <\/span>fastlane ios build.\u00a0<\/i><\/b><\/p>\n
      Result<\/strong>:-<\/strong> This will generate the .ipa file and upload to Firebase App Distribution on Firebase Console.<\/span><\/p>\n
      \"null\"<\/p>\n
      Uploaded build link:<\/span><\/p>\n
      \"null\"<\/p>\n
      Concluding that we have covered the CI\/CD workflow via Fastlane & Firebase on the local machine in Part – 2. We’ll cover in the next part how to use CI\/CD workflow via Fastlane & Firebase with Gitlab Actions. Stay tuned!<\/p>\n","protected":false},"excerpt":{"rendered":"
      In the first part of the blog, we covered the Fastlane setup\/Installation with multiple files like Appfile, Gymfile, and Fastfile. Now we are moving to the next part of this series where we will use CI\/CD workflow via Fastlane & Firebase on the local machine. We will use the next step of the Code Signing […]<\/p>\n","protected":false},"author":1898,"featured_media":0,"comment_status":"open","ping_status":"closed","sticky":false,"template":"","format":"standard","meta":{"iawp_total_views":325,"footnotes":""},"categories":[1400],"tags":[4252,6073,4848,4078],"class_list":["post-63278","post","type-post","status-publish","format-standard","hentry","category-ios","tag-cicd","tag-gitlab","tag-ios","tag-pipeline"],"aioseo_notices":[],"aioseo_head":"\n\t\t\n\t\n\t\n\t\n\t\n\t\n\t\t\n\t\t\n\t\t\n\t\t\n\t\t\n\t\t\n\t\t\n\t\t\n\t\t\n\t\t\n\t\t\n\t\t\n\t\t\n\t\t
Add the Below Script on the Fastlane File-<\/span>
\n\"null\"<\/a><\/p>\n
Now Match file will be created on your root Directory-<\/span>
\n\"null\"<\/a><\/p>\n