Skip to content

New-ConfigurationAppleApp.md

Latest commit

 

History

History
244 lines (194 loc) · 5.89 KB

New-ConfigurationAppleApp.md

File metadata and controls

244 lines (194 loc) · 5.89 KB
Raw
external help file PSPublishModule-help.xml
Module Name PSPublishModule
online version https://github.com/EvotecIT/PSPublishModule
schema 2.0.0

New-ConfigurationAppleApp

SYNOPSIS

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

SYNTAX

ExplicitVersion (Default)

New-ConfigurationAppleApp [-ProjectPath] <string> -MarketingVersion <string> [-Name <string>] [-BundleId <string>] [-Platform <ApplePlatform>] [-ArchiveVariant <AppleArchiveVariant>] [-Scheme <string>] [-AppStoreConnectAppId <string>] [-BuildNumber <string>] [-BuildNumberPolicy <AppleBuildNumberPolicy>] [-Disabled] [<CommonParameters>]

ResolvedVersion

New-ConfigurationAppleApp [-ProjectPath] <string> -UseResolvedVersion [-Name <string>] [-BundleId <string>] [-Platform <ApplePlatform>] [-ArchiveVariant <AppleArchiveVariant>] [-Scheme <string>] [-AppStoreConnectAppId <string>] [-BuildNumber <string>] [-BuildNumberPolicy <AppleBuildNumberPolicy>] [-Disabled] [<CommonParameters>]

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

EXAMPLE 1

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.

PARAMETERS

-AppStoreConnectAppId

Optional App Store Connect app id for future remote metadata checks.

Type: String
Parameter Sets: ExplicitVersion, ResolvedVersion
Aliases: None
Possible values:

Required: False
Position: named
Default value: None
Accept pipeline input: False
Accept wildcard characters: True

-ArchiveVariant

Optional archive destination variant, such as Mac Catalyst.

Type: AppleArchiveVariant
Parameter Sets: ExplicitVersion, ResolvedVersion
Aliases: None
Possible values: Default, MacCatalyst

Required: False
Position: named
Default value: None
Accept pipeline input: False
Accept wildcard characters: True

-BuildNumber

Optional explicit build number.

Type: String
Parameter Sets: ExplicitVersion, ResolvedVersion
Aliases: None
Possible values:

Required: False
Position: named
Default value: None
Accept pipeline input: False
Accept wildcard characters: True

-BuildNumberPolicy

Build number policy used when preparing the local Xcode project.

Type: AppleBuildNumberPolicy
Parameter Sets: ExplicitVersion, ResolvedVersion
Aliases: None
Possible values: Explicit, KeepExisting, IncrementExisting

Required: False
Position: named
Default value: None
Accept pipeline input: False
Accept wildcard characters: True

-BundleId

Bundle identifier, e.g. com.example.Tactra.

Type: String
Parameter Sets: ExplicitVersion, ResolvedVersion
Aliases: None
Possible values:

Required: False
Position: named
Default value: None
Accept pipeline input: False
Accept wildcard characters: True

-Disabled

Disable this configuration entry without removing it from a build script.

Type: SwitchParameter
Parameter Sets: ExplicitVersion, ResolvedVersion
Aliases: None
Possible values:

Required: False
Position: named
Default value: None
Accept pipeline input: False
Accept wildcard characters: True

-MarketingVersion

The value to assign to all MARKETING_VERSION entries.

Type: String
Parameter Sets: ExplicitVersion
Aliases: None
Possible values:

Required: True
Position: named
Default value: None
Accept pipeline input: False
Accept wildcard characters: True

-Name

Friendly app name used in logs and reports.

Type: String
Parameter Sets: ExplicitVersion, ResolvedVersion
Aliases: None
Possible values:

Required: False
Position: named
Default value: None
Accept pipeline input: False
Accept wildcard characters: True

-Platform

Apple platform for this app target.

Type: ApplePlatform
Parameter Sets: ExplicitVersion, ResolvedVersion
Aliases: None
Possible values: iOS, iPadOS, macOS, tvOS, watchOS, visionOS

Required: False
Position: named
Default value: None
Accept pipeline input: False
Accept wildcard characters: True

-ProjectPath

Path to a .xcodeproj directory or project.pbxproj file. Relative paths resolve from the pipeline project root.

Type: String
Parameter Sets: ExplicitVersion, ResolvedVersion
Aliases: Path, FullName
Possible values:

Required: True
Position: 0
Default value: None
Accept pipeline input: False
Accept wildcard characters: True

-Scheme

Xcode scheme name for future archive/export automation.

Type: String
Parameter Sets: ExplicitVersion, ResolvedVersion
Aliases: None
Possible values:

Required: False
Position: named
Default value: None
Accept pipeline input: False
Accept wildcard characters: True

-UseResolvedVersion

Uses the pipeline resolved version as the MARKETING_VERSION value.

Type: SwitchParameter
Parameter Sets: ResolvedVersion
Aliases: None
Possible values:

Required: True
Position: named
Default value: None
Accept pipeline input: False
Accept wildcard characters: True

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

INPUTS

  • None

OUTPUTS

  • System.Object

RELATED LINKS

  • None