InstallAppleProvisioningProfile@1 - Install Apple provisioning profile v1 task
Use this task to install an Apple provisioning profile, which is required in order to build on a macOS agent.
Syntax
# Install Apple provisioning profile v1
# Install an Apple provisioning profile required to build on a macOS agent machine.
- task: InstallAppleProvisioningProfile@1
inputs:
provisioningProfileLocation: 'secureFiles' # 'secureFiles' | 'sourceRepository'. Required. Provisioning profile location. Default: secureFiles.
provProfileSecureFile: # string. Required when provisioningProfileLocation == secureFiles. Provisioning profile.
#provProfileSourceRepository: # string. Required when provisioningProfileLocation == sourceRepository. Provisioning profile.
#removeProfile: true # boolean. Remove profile after build. Default: true.
# Install Apple Provisioning Profile v1
# Install an Apple provisioning profile required to build on a macOS agent.
- task: InstallAppleProvisioningProfile@1
inputs:
provisioningProfileLocation: 'secureFiles' # 'secureFiles' | 'sourceRepository'. Required. Provisioning profile location. Default: secureFiles.
provProfileSecureFile: # string. Required when provisioningProfileLocation == secureFiles. Provisioning profile.
#provProfileSourceRepository: # string. Required when provisioningProfileLocation == sourceRepository. Provisioning profile.
#removeProfile: true # boolean. Remove profile after build. Default: true.
Inputs
provisioningProfileLocation
- Provisioning profile location
string
. Required. Allowed values: secureFiles
(Secure Files), sourceRepository
(Source Repository). Default value: secureFiles
.
Specifies the location of the provisioning profile to install. The provisioning profile can be uploaded to Secure Files
, or stored in your source repository or a local path on the agent.
provProfileSecureFile
- Provisioning profile
string
. Required when provisioningProfileLocation == secureFiles
.
Specifies the provisioning profile that was uploaded to Secure Files
to install on the macOS agent.
provProfileSourceRepository
- Provisioning profile
string
. Required when provisioningProfileLocation == sourceRepository
.
Specifies the provisioning profile from the source repository or the local path to a provisioning profile on the macOS agent.
removeProfile
- Remove profile after build
boolean
. Default value: true
.
Specifies that the provisioning profile should be removed from the agent after the build or release is complete.
Task control options
All tasks have control options in addition to their task inputs. For more information, see Control options and common task properties.
Output variables
This task defines the following output variables, which you can consume in downstream steps, jobs, and stages.
provisioningProfileUuid
The UUID property for the selected provisioning profile.
provisioningProfileName
The Name property for the selected provisioning profile.
Remarks
You can use this task to install provisioning profiles needed to build iOS Apps, Apple WatchKit apps, and App extensions.
You can install an Apple provisioning profile that is:
- Stored as a secure file on the server.
- Committed to the source repository or copied to a local path on the macOS agent. You should encrypt the provisioning profiles if you are committing them to the source repository. The Decrypt File task can be used to decrypt the profiles during a build or release.
Requirements
Requirement | Description |
---|---|
Pipeline types | YAML, Classic build, Classic release |
Runs on | Agent, DeploymentGroup |
Demands | Self-hosted agents must have capabilities that match the following demands to run jobs that use this task: xcode |
Capabilities | This task does not satisfy any demands for subsequent tasks in the job. |
Command restrictions | This task runs using the following command restrictions: restricted |
Settable variables | This task has permission to set the following variables: provisioningProfileUuid, provisioningProfileName, APPLE_PROV_PROFILE_UUID |
Agent version | 2.182.1 or greater |
Task category | Utility |
Requirement | Description |
---|---|
Pipeline types | YAML, Classic build, Classic release |
Runs on | Agent, DeploymentGroup |
Demands | Self-hosted agents must have capabilities that match the following demands to run jobs that use this task: xcode |
Capabilities | This task does not satisfy any demands for subsequent tasks in the job. |
Command restrictions | Any |
Settable variables | Any |
Agent version | 2.116.0 or greater |
Task category | Utility |