Command

New-ConfigurationAppleApp

Module: PSPublishModule
Inputs: None

Creates configuration for preparing an Apple app target in a release pipeline.

Syntax

New-ConfigurationAppleApp
[-AppStoreConnectAppId <String>]
[-ArchiveVariant <Default|MacCatalyst>]
[-BuildNumber <String>]
[-BuildNumberPolicy <Explicit|KeepExisting|IncrementExisting>]
[-BundleId <String>]
[-Disabled]
-MarketingVersion <String>
[-Name <String>]
[-Platform <ApplePlatform>]
[-ProjectPath] <String>
[-RequiredPrivacyUsageDescriptionKeys <String[]>]
[-Scheme <String>]
[<CommonParameters>]

Parameter set: ExplicitVersion

New-ConfigurationAppleApp
[-AppStoreConnectAppId <String>]
[-ArchiveVariant <Default|MacCatalyst>]
[-BuildNumber <String>]
[-BuildNumberPolicy <Explicit|KeepExisting|IncrementExisting>]
[-BundleId <String>]
[-Disabled]
[-Name <String>]
[-Platform <ApplePlatform>]
[-ProjectPath] <String>
[-RequiredPrivacyUsageDescriptionKeys <String[]>]
[-Scheme <String>]
-UseResolvedVersion
[<CommonParameters>]

Parameter set: ResolvedVersion

Description

Emits an Apple app configuration segment consumed by Invoke-ModuleBuild / Build-Module. The segment prepares local Xcode project version metadata. App Store Connect metadata is kept as configuration for future read-only checks and publish/review commands.

Examples

Prepare an iOS app using the resolved pipeline version

New-ConfigurationAppleApp -Name Tactra -Platform iOS -ProjectPath .\Tactra.xcodeproj -Scheme Tactra -BundleId com.example.Tactra -UseResolvedVersion -BuildNumberPolicy IncrementExisting

Sets MARKETING_VERSION from the pipeline version and increments CURRENT_PROJECT_VERSION.

Parameters

-AppStoreConnectAppId String optional: Optional App Store Connect app id for future remote metadata checks.
-ArchiveVariant AppleArchiveVariant optional: Optional archive destination variant, such as Mac Catalyst.; Possible values: Default, MacCatalyst
-BuildNumber String optional: Optional explicit build number.
-BuildNumberPolicy AppleBuildNumberPolicy optional: Build number policy used when preparing the local Xcode project.; Possible values: Explicit, KeepExisting, IncrementExisting
-BundleId String optional: Bundle identifier, e.g. com.example.Tactra.
-Disabled SwitchParameter optional: Disable this configuration entry without removing it from a build script.
-MarketingVersion String requiredsets: ExplicitVersion: The value to assign to all MARKETING_VERSION entries.
-Name String optional: Friendly app name used in logs and reports.
-Platform ApplePlatform optional: Apple platform for this app target.; Possible values: iOS, iPadOS, macOS, tvOS, watchOS, visionOS
-ProjectPath String requiredposition: 0aliases: FullName, Path: Path to a .xcodeproj directory or project.pbxproj file. Relative paths resolve from the pipeline project root.
-RequiredPrivacyUsageDescriptionKeys String[] optional: Privacy purpose-string keys that must contain non-empty values in the final archived app before upload.
-Scheme String optional: Xcode scheme name for future archive/export automation.
-UseResolvedVersion SwitchParameter requiredsets: ResolvedVersion: Uses the pipeline resolved version as the MARKETING_VERSION value.

Common Parameters

This command supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable.

For more information, see about_CommonParameters.