Gym (Fastlane): vad det är, IPA-byggen och automatisering i apputveckling

Vad är Gym (Fastlane)?

Gym (Fastlane) är en komponent i Fastlane-ekosystemet som möjliggör byggande av iOS-appar till IPA-format via ett enda terminalkommando. Det abstraherar den komplexa processen att anropa xcodebuild med dussintals flaggor och ger utvecklaren ett enkelt gränssnitt med rimliga standardvärden.

I Xcode krävs det för att bygga en IPA att öppna projektet, välja schema, konfigurera Archive och Export, ange distributionsmetod och vänta på slutförande. Byggautomatisering via Gym eliminerar manuella steg och garanterar att varje bygge utförs med samma parametrar — detta är avgörande för förutsägbarheten i CI/CD-pipelinen.

Enligt SwiftLee (2024) lägger team som använder Gym för byggen 40% mindre tid på att konfigurera releaseprocessen jämfört med manuell export via Xcode Organizer. Gym genererar också detaljerade byggloggar med angivelse av varje xcodebuild-steg, vilket förenklar felsökning av misslyckade builds och analys av kompileringsfel.

Använd Gym i alla iOS-projekt som kräver regelbundna IPA-byggen för testning eller publicering — det är det enda sättet att garantera identisk byggkonfiguration på alla maskiner i teamet.

Hur Gym bygger IPA: process och parametrar

Processen för IPA-bygge via Gym

IPA-bygge via Gym består av tre på varandra följande steg: arkivering av projektet via xcodebuild, export av arkivet till ett binärt paket och paketering till IPA-format med signatur. Gym bestämmer automatiskt projekttypen (single target eller workspace) och väljer rätt byggmetod.

I arkiveringsfasen kör Gym xcodebuild archive med parametrarna för schema och konfiguration som anges i projektet. Efter framgångsrik skapelse av .xcarchive-arkivet kör Gym xcodebuild -exportArchive med den valda exportmetoden. IPA-export är processen att konvertera .xcarchive-arkivet till en .ipa-installationsfil med alla nödvändiga resurser och signaturer.

Exportparametrar för bygget

Exportmetoden bestämmer vilken typ av Provisioning Profile som ska användas för att signera IPA. Gym stöder fyra metoder: development för felsökning på utvecklarenheter, app-store för publicering i App Store, ad-hoc för betatestning på ett begränsat antal enheter och enterprise för företagsdistribution.

Ytterligare parametrar inkluderar specificering av export_options_plist för exakt exportkonfiguration, undertryckning av Swift overlay för att minska IPA-storleken och hantering av bitcode. Gym stöder också byggen för simulatorn via flaggan --skip_package_ipa, vilket är användbart för snabb kodkontroll utan fullständig export.

# Grundläggande IPA-bygge via Gym
fastlane gym --workspace "MyApp.xcworkspace" --scheme "MyApp"

# Bygge med angiven exportmetod
fastlane gym --export_method app-store

# Bygg bara arkivet utan IPA-export
fastlane gym --skip_package_ipa

Konfigurera Gym via Gymfile

Gymfile är en Fastlane-konfigurationsfil som lagrar alla byggparametrar i strukturerat Ruby-format. Till skillnad från att skicka flaggor via kommandoraden gör Gymfile det möjligt att låsa konfigurationen i repositoryt och garantera att alla utvecklare och CI använder identiska bygginställningar.

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

Parametern export_method i Gymfile motsvarar profiltyperna från Apple Developer Portal. För App Store-versioner används :app-store, för testning — :development eller :ad-hoc. Parametern configuration bestämmer byggkonfigurationen: Release för versioner eller Debug för felsökningsversioner.

Parametern include_bitcode styr inkluderingen av bitcode i IPA. Apple krävde bitcode för watchOS- och tvOS-appar, men för iOS kan denna parameter stängas av för att minska den binära filstorleken. include_symbols inkluderar .dSYM symboliska felsökningsfiler som är nödvändiga för symbolisering av crashloggar från App Store Connect eller tredjepartsövervakningstjänster.

Ytterligare Gymfile-parametrar inkluderar export_options_plist för en anpassad export-plist-fil, silent för att undertrycka överflödig utdata i loggar och build_path för att ange en temporär byggkatalog. Dessa parametrar är användbara vid integration av Gym i komplexa CI/CD-pipelines med särskilda krav på artefakter.

Gym-kommandon för att bygga appar

Kommandogränssnittet Gym innehåller grundläggande parametrar för typiska byggscenarier och utökade flaggor för exakt beteendekonfiguration. De flesta parametrar kan skickas både via kommandoraden och via Gymfile, där kommandoradsargument har prioritet över konfigurationsfilen.

Kommandot fastlane gym utan parametrar använder inställningarna från Gymfile eller bestämmer automatiskt projektet i den aktuella katalogen. För projekt med flera mål måste --scheme och --workspace anges för korrekt val av målbyggkonfiguration.

Typiska byggkommandon

För ett snabbt felsökningsbygge används fastlane gym --export_method development — det bygger en IPA med en Development-profil för installation på utvecklarenheter. IPA-bygge för App Store kräver flaggan --export_method app-store och användning av ett Distribution-certifikat som måste vara förkonfigurerat i Match eller Keychain.

# Bygge för App Store med anpassat namn
fastlane gym --export_method app-store --output_name "Release_1.0.ipa"

# Bygge med rensning före arkivering
fastlane gym --clean --configuration Debug

# Bygge för simulatorn utan IPA
fastlane gym --skip_package_ipa --destination "generic/platform=iOS Simulator"

Flaggan --clean tar bort temporära filer från föregående bygge före körning, vilket förhindrar användning av föråldrad cache och garanterar ett rent bygge. Flaggan --destination gör det möjligt att ange målplattform för bygget: iOS Simulator, iOS Device eller macOS Catalyst.

Integrera Gym i CI/CD-pipeline

Integrera Gym med CI/CD är en standardpraxis för iOS-utvecklingsteam som strävar efter kontinuerlig leverans. Gym körs i GitHub Actions-, GitLab CI-, Bitrise- eller Jenkins-pipelines efter testfasen och före sändning till TestFlight eller App Store.

En typisk iOS CI/CD-pipeline inkluderar: kloning av repositoryt, installation av beroenden via CocoaPods eller SPM, konfiguration av certifikat via Match, byggande av IPA via Gym och uppladdning via Pilot eller Deliver. GitLab CI är ett kontinuerligt integrationssystem från GitLab som gör det möjligt att starta byggen vid varje push till repositoryt.

# Exempel på byggsteg i GitLab CI
fastlane gym --scheme "MyApp" \
      --export_method app-store \
      --output_directory "$CI_PROJECT_DIR/build"
      
# Spara IPA som byggartefakt
cp "build/MyApp.ipa" "$CI_PROJECT_DIR/artifacts/"

För att Gym ska fungera korrekt i CI måste xcodebuild få åtkomst till Keychain med certifikat. Detta görs via kommandot security unlock-keychain före start av Gym. Om Match används installeras certifikaten automatiskt och separat Keychain-konfiguration krävs inte — Match skapar själv en temporär nyckelkedja för bygget.

Efter ett framgångsrikt bygge kan IPA skickas vidare till nästa steg i pipelinen: uppladdning till TestFlight via Pilot eller sändning till App Store Connect via Deliver. Konfigurera CI-systemets miljövariabler för lagring av Apple Developer-inloggningsuppgifter, inklusive FASTLANE_APPLE_API_KEY och MATCH_PASSWORD, så att alla pipeline-steg fungerar utan interaktiv inmatning.

Vanliga Gym-byggfel

Vid användning av Gym stöter utvecklare ofta på fel relaterade till felaktig xcodebuild-konfiguration, saknade certifikat eller inkompatibilitet mellan Xcode-versioner. Feldiagnostik för Gym börjar med analys av den fullständiga byggloggen som visas i konsolen efter varje kommando.

Felet «error: No matching provisioning profiles found» indikerar att det saknas en lämplig Provisioning Profile för den valda exportmetoden. Lösning: se till att Match eller Keychain innehåller en korrekt profil för angiven export_method. Provisioning Profile måste matcha applikationsidentifieraren och certifikattypen (Development eller Distribution) för framgångsrik IPA-signering.

Felet «error: Signing for requires a development team» uppstår när inget utvecklingsteam har angetts i projektet. Lösning: lägg till DEVELOPMENT_TEAM i projektets byggkonfiguration eller ange team_id i Gymfile via parametern export_team_id. Detta är särskilt viktigt för projekt som arbetar med flera Apple Developer-konton.

Vid felet «error: Multiple commands produce...» uppstår en konflikt mellan utdatafiler från olika mål i workspace. Lösning: konfigurera unika utdatasökvägar för varje mål i Build Settings i Xcode-projektet eller använd det nya byggsystemet som är aktiverat som standard i Xcode 14 och nyare. Gym stöder båda varianterna via flaggan --use_legacy_build_system.