Xcode@2 - Tâche de build Xcode v2
Utilisez cette tâche pour générer un espace de travail Xcode sur macOS.
Syntax
# Xcode Build v2
# Build an Xcode workspace on Mac OS.
- task: Xcode@2
inputs:
actions: 'build' # string. Required. Actions. Default: build.
#configuration: '$(Configuration)' # string. Configuration. Default: $(Configuration).
#sdk: '$(SDK)' # string. SDK. Default: $(SDK).
#xcWorkspacePath: '**/*.xcodeproj/*.xcworkspace' # string. Workspace/Project Path. Default: **/*.xcodeproj/*.xcworkspace.
#scheme: # string. Scheme.
#packageApp: true # boolean. Create App Package. Default: true.
# Package Options
packageTool: 'xcodebuild' # 'xcrun' | 'xcodebuild'. Required. Create Package (IPA) using. Default: xcodebuild.
#archivePath: # string. Optional. Use when packageTool == xcodebuild. Archive Path.
#exportPath: 'output/$(SDK)/$(Configuration)' # string. Optional. Use when packageTool == xcodebuild. Export Path. Default: output/$(SDK)/$(Configuration).
#exportOptions: 'auto' # 'auto' | 'plist' | 'specify'. Optional. Use when packageTool == xcodebuild. Export Options. Default: auto.
#exportMethod: 'development' # string. Required when exportOptions == specify. Export Method. Default: development.
#exportTeamId: # string. Optional. Use when exportOptions == specify. Team ID.
#exportOptionsPlist: # string. Required when exportOptions == plist. Export Options Plist.
# Signing & Provisioning
#xcode8AutomaticSigning: false # boolean. Automatic Signing. Default: false.
#teamId: # string. Optional. Use when xcode8AutomaticSigning = true. Team ID.
#signMethod: 'file' # 'file' | 'id'. Override Using. Default: file.
#iosSigningIdentity: # string. Optional. Use when signMethod = id. Signing Identity.
#unlockDefaultKeychain: false # boolean. Optional. Use when signMethod = id. Unlock Default Keychain. Default: false.
#defaultKeychainPassword: # string. Optional. Use when signMethod = id. Default Keychain Password.
#provProfileUuid: # string. Optional. Use when signMethod = id. Provisioning Profile UUID.
#p12: # string. Optional. Use when signMethod = file. P12 Certificate File.
#p12pwd: # string. Optional. Use when signMethod = file. P12 Password.
#provProfile: # string. Optional. Use when signMethod = file. Provisioning Profile File.
#removeProfile: false # boolean. Optional. Use when signMethod = file. Remove Profile After Build. Default: false.
# Advanced
#args: # string. Arguments.
#cwd: # string. Working Directory.
outputPattern: 'output/$(SDK)/$(Configuration)' # string. Required. Output Directory. Default: output/$(SDK)/$(Configuration).
#xcodeDeveloperDir: # string. Xcode Developer Path.
#useXcpretty: false # boolean. Use xcpretty. Default: false.
#publishJUnitResults: false # boolean. Publish to VSTS/TFS. Default: false.
# xctool (deprecated)
#useXctool: # boolean. Use xctool.
#xctoolReporter: # string. xctool Test Reporter Format.
Entrées
actions
- Actions
string
. Obligatoire. Valeur par défaut : build
.
Spécifie une liste d’actions délimitée par des espaces. Les options valides sont build
, clean
, test
, analyze
et archive
. Par exemple, build clean
effectue une build propre. Consultez le FAQ Apple : Génération à partir de la ligne de commande avec Xcode.
configuration
- Configuration
string
. Valeur par défaut : $(Configuration)
.
Spécifie la configuration du projet Xcode ou de l’espace de travail à générer. Lorsque vous utilisez une variable, spécifiez une valeur (par exemple, Release
) sous l’onglet Variables .
sdk
- SDK
string
. Valeur par défaut : $(SDK)
.
Génère un projet ou un espace de travail Xcode par rapport au KIT de développement logiciel (SDK) spécifié. Exécutez xcodebuild -showsdks
pour afficher une liste valide de kits SDK.
xcWorkspacePath
- Chemin d’accès de l’espace de travail/du projet
string
. Valeur par défaut : **/*.xcodeproj/*.xcworkspace
.
facultatif. Spécifie le chemin d’accès relatif de la racine du dépôt à l’espace de travail ou au projet Xcode. Par exemple, MyApp/MyApp.xcworkspace
ou MyApp/MyApp.xcworkspace/MyApp.xcodeproj
.
Laissez vide si vous envisagez d’utiliser -target flag
sous Arguments avancés.
scheme
- Régime
string
.
facultatif. Spécifie le nom du schéma Xcode. Doit être un schéma partagé (case à cocher partagée sous Schémas managés dans Xcode). Obligatoire si l’espace de travail est spécifié.
packageApp
- Créer un package d’application
boolean
. Valeur par défaut : true
.
Spécifie si un IPA est généré dans le cadre de la build. Pour exporter des archives avec Xcode 7 et Xcode 8, passez en revue les entrées supplémentaires dans la section Options de package .
packageTool
- Créer un package (IPA) à l’aide de
string
. Obligatoire. Valeurs autorisées : xcrun
(xcrun (déconseillé par Apple)), xcodebuild
(archive et exportation xcodebuild). Valeur par défaut : xcodebuild
.
Spécifie l’outil à utiliser pour générer l’IPA.
archivePath
- Chemin d’accès à l’archive
string
. facultatif. Utilisez quand packageTool == xcodebuild
.
Spécifie un répertoire dans lequel les archives créées sont placées.
exportPath
- Chemin d’exportation
string
. facultatif. Utilisez quand packageTool == xcodebuild
. Valeur par défaut : output/$(SDK)/$(Configuration)
.
Spécifie la destination du produit exporté à partir de l’archive.
exportOptions
- Options d’exportation
string
. facultatif. Utilisez quand packageTool == xcodebuild
. Valeurs autorisées : auto
, plist
, specify
. Valeur par défaut : auto
.
Spécifie un moyen de transmettre les options d’exportation lors de l’exportation de l’archive.
exportMethod
- Export, méthode
string
. Nécessaire lorsque exportOptions == specify
. Valeur par défaut : development
.
Spécifie la méthode utilisée par Xcode pour exporter l’archive. Par exemple, app-store
, package
, ad-hoc
, enterprise
ou development
.
exportTeamId
- ID d’équipe
string
. facultatif. Utilisez quand exportOptions == specify
.
Spécifie l’ID d’équipe à 10 chiffres du portail des développeurs Apple à utiliser pour l’exportation.
exportOptionsPlist
- Export Options Plist
string
. Nécessaire lorsque exportOptions == plist
.
Spécifie le chemin d’accès à un fichier plist qui configure l’exportation d’archive.
xcode8AutomaticSigning
- Signature automatique
boolean
. Valeur par défaut : false
.
Utilisez cette entrée si vous avez un projet Xcode 8 ou Xcode 9 configuré pour la signature automatique.
teamId
- ID d’équipe
string
. facultatif. Utilisez quand xcode8AutomaticSigning = true
.
Spécifie l’ID d’équipe de développeur à 10 chiffres. Cette option est obligatoire si vous êtes membre de plusieurs équipes de développement.
signMethod
- Remplacer à l’aide de
string
. Valeurs autorisées : file
(Contenu du fichier), id
(Identificateurs). Valeur par défaut : file
.
Utilisez cette entrée si la build utilise une méthode de signature ou d’approvisionnement différente de la méthode par défaut. Choisissez File Contents
d’utiliser un certificat P12 et un profil d’approvisionnement. Choisissez Identifiers
de récupérer les paramètres de signature à partir des profils keychain et préinstallés par défaut. Laissez les champs correspondants vides si vous ne souhaitez pas remplacer les paramètres de build par défaut.
iosSigningIdentity
- Identité de signature
string
. facultatif. Utilisez quand signMethod = id
.
Spécifie le remplacement d’identité de signature utilisé pour signer la build. La valeur par défaut est le paramètre de projet Xcode. Vous devrez peut-être sélectionner Déverrouiller le trousseau par défaut.
unlockDefaultKeychain
- Déverrouiller le trousseau par défaut
boolean
. facultatif. Utilisez quand signMethod = id
. Valeur par défaut : false
.
Résout les erreurs d’interaction utilisateur non autorisées en déverrouillant le keychain par défaut.
defaultKeychainPassword
- Mot de passe du trousseau par défaut
string
. facultatif. Utilisez quand signMethod = id
.
Spécifie le mot de passe pour déverrouiller le keychain par défaut.
provProfileUuid
- UUID du profil d’approvisionnement
string
. facultatif. Utilisez quand signMethod = id
.
Spécifie l’UUID d’un profil d’approvisionnement installé à utiliser pour la build. Utilisez des tâches de génération distinctes avec différents schémas ou cibles pour spécifier des profils d’approvisionnement par cible dans un espace de travail unique (iOS, WatchKit, tvOS).
p12
- Fichier de certificat P12
string
. facultatif. Utilisez quand signMethod = file
.
Spécifie le chemin d’accès relatif à un fichier de certificat P12 au format PKCS12 qui contient un certificat de signature à utiliser pour la build.
p12pwd
- Mot de passe P12
string
. facultatif. Utilisez quand signMethod = file
.
Spécifie le mot de passe d’un fichier de certificat P12 s’il est spécifié. Utilisez une variable de build pour chiffrer.
provProfile
- Fichier de profil d’approvisionnement
string
. facultatif. Utilisez quand signMethod = file
.
Spécifie le chemin d’accès relatif à un fichier contenant un remplacement de profil d’approvisionnement à utiliser pour la build. Utilisez des tâches de génération distinctes avec différents schémas ou cibles pour spécifier des profils d’approvisionnement par cible dans un espace de travail unique (iOS, WatchKit, tvOS).
removeProfile
- Supprimer le profil après la génération
boolean
. facultatif. Utilisez quand signMethod = file
. Valeur par défaut : false
.
Supprime le contenu du fichier de profil d’approvisionnement de l’agent de build une fois la génération terminée. Uniquement case activée si vous exécutez un agent par utilisateur.
args
- Arguments
string
.
Spécifie les arguments de ligne de commande supplémentaires utilisés pour générer. Cette entrée est utile si vous souhaitez utiliser -target
ou -project
au lieu de spécifier un espace de travail et un schéma.
cwd
- Répertoire de travail
string
.
Spécifie le répertoire de travail pour les exécutions de build. La valeur par défaut est la racine du dépôt.
outputPattern
- Répertoire de sortie
string
. Obligatoire. Valeur par défaut : output/$(SDK)/$(Configuration)
.
Spécifie le chemin d’accès relatif où la sortie de build (binaires) est placée.
xcodeDeveloperDir
- Chemin du développeur Xcode
string
.
facultatif. Spécifie le chemin d’accès au dossier Xcode Developer s’il ne s’agit pas de la valeur par défaut du système. À utiliser lorsque plusieurs versions de Xcode sont installées sur un système. Par exemple : /Applications/Xcode 7.app/Contents/Developer
.
useXcpretty
- Utiliser xcpretty
boolean
. Valeur par défaut : false
.
Met en forme xcodebuild
la sortie et génère un rapport de résultats de test JUnit. Doit être installé sur les hôtes de l’agent. En savoir plus sur xcpretty.
publishJUnitResults
- Publier sur VSTS/TFS
boolean
. Valeur par défaut : false
.
Les résultats des tests JUnit qui ont été produits à l’aide xctool
de sont publiés sur VSTS/TFS.
useXctool
- Utiliser xctool
boolean
.
Utilise xctool
au lieu de xcodebuild
. Doit être installé sur les hôtes de l’agent. En savoir plus sur xctool.
Note:xctool
est déconseillé et ne fonctionne pas avec Xcode 8.
xctoolReporter
- Xctool Test Reporter Format
string
.
Teste le format reporter à utiliser lorsque l’action de test est spécifiée et que l’option Utiliser xctool est cochée. Spécifiez junit:output-file-path-here.xml
pour générer un format de fichier compatible avec la tâche Publier les résultats des tests. Lorsqu’il est spécifié, le texte brut est automatiquement ajouté. xctool
doit être installé sur les hôtes de l’agent. En savoir plus sur xctool.
Note:xctool
est déconseillé et ne fonctionne pas avec Xcode 8.
Options de contrôle de la tâche
Toutes les tâches ont des options de contrôle en plus de leurs entrées de tâches. Pour plus d’informations, consultez Options de contrôle et propriétés de tâche courantes.
Variables de sortie
Aucun.
Configuration requise
Condition requise | Description |
---|---|
Types de pipelines | YAML, build classique |
S’exécute sur | Agent, DeploymentGroup |
Demandes | Les agents auto-hébergés doivent avoir des fonctionnalités qui correspondent aux exigences suivantes pour exécuter des travaux qui utilisent cette tâche : xcode |
Capabilities | Cette tâche ne répond à aucune demande pour les tâches suivantes dans le travail. |
Restrictions de commande | Quelconque |
Variables paramétrables | Quelconque |
Version de l’agent | Toutes les versions d’agent prises en charge. |
Catégorie de la tâche | Build |