New-ConfigurationAppleApp

Namespace PSPublishModule

Inputs

None

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

Remarks

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

Authored help example

Prepare an iOS app using the resolved pipeline version

PS>


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.

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.

Syntax

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

Parameter set: ExplicitVersion

Parameters

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

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

Parameter set: ResolvedVersion

Parameters

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