Gym (Fastlane): ano ito, pagbuo ng IPA at automation sa pag-develop ng aplikasyon

Ano ang Gym (Fastlane)?

Gym (Fastlane) ay isang bahagi ng Fastlane ecosystem na nagbibigay ng pagbuo ng mga iOS application sa IPA format sa pamamagitan ng isang terminal command. Inaabstrak nito ang komplikadong proseso ng pagtawag sa xcodebuild na may dose-dosenang flag at nagbibigay sa developer ng simpleng interface na may makatwirang default na halaga.

Sa Xcode, para makabuo ng IPA kailangan buksan ang proyekto, piliin ang scheme, i-configure ang Archive at Export, tukuyin ang paraan ng pamamahagi at maghintay ng pagkumpleto. Automation ng pagbuo sa pamamagitan ng Gym ay tinatanggal ang mga manu-manong hakbang at ginagarantiyahan na ang bawat pagbuo ay isinasagawa na may parehong mga parameter — ito ay kritikal para sa predictability ng CI/CD pipeline.

Ayon sa SwiftLee (2024), ang mga team na gumagamit ng Gym para sa pagbuo ay gumugugol ng 40% mas kaunting oras sa pag-configure ng release process kumpara sa manu-manong pag-export sa pamamagitan ng Xcode Organizer. Ang Gym ay bumubuo rin ng detalyadong build log na may indikasyon ng bawat hakbang ng xcodebuild, na nagpapadali sa pag-debug ng mga failed build at pagsusuri ng mga compilation error.

Gamitin ang Gym sa anumang iOS project na nangangailangan ng regular na pagbuo ng IPA para sa pagsubok o publikasyon — ito ang tanging paraan upang garantiya ang identikal na configuration ng pagbuo sa lahat ng makina sa team.

Paano bumubuo ang Gym ng IPA: proseso at mga parameter

Proseso ng pagbuo ng IPA sa pamamagitan ng Gym

Ang pagbuo ng IPA sa pamamagitan ng Gym ay binubuo ng tatlong sunud-sunod na yugto: pag-archive ng proyekto sa pamamagitan ng xcodebuild, pag-export ng archive sa binary package at pag-pack sa IPA format na may pirma. Awtomatikong tinutukoy ng Gym ang uri ng proyekto (single target o workspace) at pinipili ang tamang paraan ng pagbuo.

Sa yugto ng pag-archive, pinapatakbo ng Gym ang xcodebuild archive na may mga parameter ng scheme at configuration na tinukoy sa proyekto. Pagkatapos ng matagumpay na paggawa ng .xcarchive archive, pinapatakbo ng Gym ang xcodebuild -exportArchive na may napiling paraan ng pag-export. Export ng IPA ay ang proseso ng pag-convert ng .xcarchive archive sa .ipa installation file na may kasamang lahat ng kinakailangang resources at pirma.

Mga parameter ng pag-export ng pagbuo

Ang paraan ng pag-export ay tumutukoy sa uri ng Provisioning Profile na gagamitin para sa pagpirma ng IPA. Sinusuportahan ng Gym ang apat na paraan: development para sa debugging sa mga device ng developer, app-store para sa publikasyon sa App Store, ad-hoc para sa beta testing sa limitadong bilang ng mga device at enterprise para sa corporate distribution.

Kasama sa mga karagdagang parameter ang pagtukoy ng export_options_plist para sa tumpak na configuration ng pag-export, pagsugpo ng Swift overlay para bawasan ang laki ng IPA at pamamahala ng bitcode. Sinusuportahan din ng Gym ang pagbuo para sa simulator sa pamamagitan ng flag na --skip_package_ipa, na kapaki-pakinabang para sa mabilisang pagsusuri ng code nang walang buong pag-export.

# Pangunahing pagbuo ng IPA gamit ang Gym
fastlane gym --workspace "MyApp.xcworkspace" --scheme "MyApp"

# Pagbuo na may tinukoy na export method
fastlane gym --export_method app-store

# Pagbuo ng archive lamang nang walang IPA export
fastlane gym --skip_package_ipa

Configuration ng Gym sa pamamagitan ng Gymfile

Gymfile ay isang configuration file ng Fastlane na nag-iimbak ng lahat ng parameter ng pagbuo sa structured Ruby format. Hindi tulad ng pagpapasa ng mga flag sa pamamagitan ng command line, pinapayagan ng Gymfile na i-lock ang configuration sa repositoryo at ginagarantiyahan na ang lahat ng developer at CI ay gumagamit ng identikal na mga setting ng pagbuo.

# Gymfile — configuration ng pagbuo
workspace("MyApp.xcworkspace")
scheme("MyApp")
export_method(:app-store)
configuration("Release")
output_directory("./build")
output_name("MyApp.ipa")
include_symbols(true)
include_bitcode(false)

Ang parameter na export_method sa Gymfile ay tumutugma sa mga uri ng profile mula sa Apple Developer Portal. Para sa App Store releases ginagamit ang :app-store, para sa pagsubok — :development o :ad-hoc. Ang parameter na configuration ay tumutukoy sa configuration ng pagbuo: Release para sa mga release o Debug para sa mga debugging version.

Ang parameter na include_bitcode ay kumokontrol sa pagsasama ng bitcode sa IPA. Kinailangan ng Apple ang bitcode para sa watchOS at tvOS application, ngunit para sa iOS ang parameter na ito ay maaaring i-off upang bawasan ang laki ng binary file. include_symbols ay may kasamang .dSYM symbolic debugging file na kinakailangan para sa simbolisasyon ng crash logs mula sa App Store Connect o third-party monitoring services.

Ang mga karagdagang parameter ng Gymfile ay may kasamang export_options_plist para sa custom na plist file ng pag-export, silent para sa pagsugpo ng labis na output sa logs at build_path para sa pagtukoy ng temporary directory ng pagbuo. Ang mga parameter na ito ay kapaki-pakinabang sa pagsasama ng Gym sa mga kumplikadong CI/CD pipeline na may mga espesyal na kinakailangan para sa artifacts.

Mga utos ng Gym para sa pagbuo ng aplikasyon

Interface ng mga utos ng Gym ay may kasamang mga pangunahing parameter para sa tipikal na mga senaryo ng pagbuo at pinalawak na mga flag para sa tumpak na configuration ng pag-uugali. Karamihan sa mga parameter ay maaaring ipasa sa pamamagitan ng command line at sa pamamagitan ng Gymfile, kung saan ang mga argumento ng command line ay may priyoridad kaysa sa configuration file.

Ang utos na fastlane gym na walang parameter ay gumagamit ng mga setting mula sa Gymfile o awtomatikong tinutukoy ang proyekto sa kasalukuyang directory. Para sa mga proyekto na may maraming target, kailangan tukuyin ang --scheme at --workspace para sa tamang pagpili ng target na configuration ng pagbuo.

Mga tipikal na utos ng pagbuo

Para sa mabilis na debugging build ginagamit ang fastlane gym --export_method development — ito ay bumubuo ng IPA na may Development profile para sa pag-install sa mga device ng developer. Pagbuo ng IPA para sa App Store ay nangangailangan ng flag na --export_method app-store at paggamit ng Distribution certificate na dapat ay naka-configure nang maaga sa Match o Keychain.

# Pagbuo para sa App Store na may custom na pangalan
fastlane gym --export_method app-store --output_name "Release_1.0.ipa"

# Pagbuo na may paglilinis bago i-archive
fastlane gym --clean --configuration Debug

# Pagbuo para sa simulator nang walang IPA
fastlane gym --skip_package_ipa --destination "generic/platform=iOS Simulator"

Ang flag na --clean ay nagtatanggal ng mga temporary file ng nakaraang pagbuo bago ang pagpapatakbo, na pumipigil sa paggamit ng lumang cache at ginagarantiyahan ang malinis na build. Ang flag na --destination ay nagpapahintulot na tukuyin ang target na platform para sa pagbuo: iOS Simulator, iOS Device o macOS Catalyst.

Pagsasama ng Gym sa CI/CD pipeline

Pagsasama ng Gym sa CI/CD ay isang standard na kasanayan para sa mga team ng iOS developer na nagsusumikap para sa tuloy-tuloy na paghahatid. Ang Gym ay pinapatakbo sa mga pipeline ng GitHub Actions, GitLab CI, Bitrise o Jenkins pagkatapos ng yugto ng pagsubok at bago ang pagpapadala sa TestFlight o App Store.

Ang tipikal na iOS CI/CD pipeline ay may kasamang: pag-clone ng repositoryo, pag-install ng dependencies sa pamamagitan ng CocoaPods o SPM, configuration ng mga certificate sa pamamagitan ng Match, pagbuo ng IPA sa pamamagitan ng Gym at pag-upload sa pamamagitan ng Pilot o Deliver. GitLab CI ay isang continuous integration system mula sa GitLab na nagpapahintulot na magsimula ng mga build sa bawat push sa repositoryo.

# Halimbawa ng build step sa GitLab CI
fastlane gym --scheme "MyApp" \
      --export_method app-store \
      --output_directory "$CI_PROJECT_DIR/build"
      
# Pag-save ng IPA bilang build artifact
cp "build/MyApp.ipa" "$CI_PROJECT_DIR/artifacts/"

Para sa tamang paggana ng Gym sa CI, kailangan i-configure ang access ng xcodebuild sa Keychain na may mga certificate. Ito ay ginagawa sa pamamagitan ng utos na security unlock-keychain bago patakbuhin ang Gym. Kung ginagamit ang Match, ang mga certificate ay awtomatikong nai-install at hindi kinakailangan ang hiwalay na configuration ng Keychain — ang Match mismo ay gumagawa ng temporary keychain para sa pagbuo.

Pagkatapos ng matagumpay na pagbuo, ang IPA ay maaaring ipasa sa mga susunod na hakbang ng pipeline: pag-upload sa TestFlight sa pamamagitan ng Pilot o pagpapadala sa App Store Connect sa pamamagitan ng Deliver. I-configure ang mga environment variable ng CI system para sa pag-iimbak ng Apple Developer credentials, kabilang ang FASTLANE_APPLE_API_KEY at MATCH_PASSWORD, upang ang lahat ng yugto ng pipeline ay gumana nang walang interactive na input.

Mga karaniwang error sa pagbuo ng Gym

Sa paggamit ng Gym, ang mga developer ay madalas nakakaranas ng mga error na may kaugnayan sa maling configuration ng xcodebuild, kakulangan ng mga certificate o hindi pagkakatugma ng mga bersyon ng Xcode. Diagnosis ng error ng Gym ay nagsisimula sa pagsusuri ng kumpletong build log na ipinapakita sa console pagkatapos ng bawat utos.

Ang error na «error: No matching provisioning profiles found» ay nagpapahiwatig ng kakulangan ng angkop na Provisioning Profile para sa napiling paraan ng pag-export. Solusyon: tiyakin na ang Match o Keychain ay naglalaman ng tamang profile para sa tinukoy na export_method. Provisioning Profile ay dapat tumugma sa identifier ng application at uri ng certificate (Development o Distribution) para sa matagumpay na pagpirma ng IPA.

Ang error na «error: Signing for requires a development team» ay nangyayari kapag ang development team ay hindi tinukoy sa proyekto. Solusyon: idagdag ang DEVELOPMENT_TEAM sa configuration ng pagbuo ng proyekto o tukuyin ang team_id sa Gymfile sa pamamagitan ng parameter na export_team_id. Ito ay lalong mahalaga para sa mga proyekto na gumagana sa maraming Apple Developer account.

Sa error na «error: Multiple commands produce...» nangyayari ang conflict ng mga output file sa pagitan ng iba't ibang target sa workspace. Solusyon: i-configure ang natatanging mga path ng output para sa bawat target sa Build Settings ng Xcode project o gamitin ang bagong build system na naka-enable bilang default sa Xcode 14 at mas bago. Sinusuportahan ng Gym ang parehong variant sa pamamagitan ng flag na --use_legacy_build_system.