API Reference
Command
Test-AppStoreConnectReleaseReadiness
Checks whether an App Store Connect Distribution version is ready for submission.
Remarks
Checks whether an App Store Connect Distribution version is ready for submission.
Examples
EXAMPLE 1
Test-AppStoreConnectReleaseReadiness -IssuerId 'Value' -KeyId 'Value' -AppId 'Value' -VersionString 'Value' -Platform '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.
Syntax
Test-AppStoreConnectReleaseReadiness -AppId <String> [-BuildNumber <String>] -IssuerId <String> -KeyId <String> [-Locale <String>] [-MinimumScreenshotsPerSet <Int32>] [-NoRequireCompleteScreenshots] [-NoRequireDescription] [-NoRequireKeywords] [-NoRequireScreenshots] [-NoRequireSelectedBuild] [-NoRequireSupportUrl] [-NoRequireValidBuild] -Platform <iOS> [-PrivateKey <String>] [-PrivateKeyPath <String>] [-RequiredScreenshotDisplayTypes <String[]>] [-RequireMarketingUrl] [-RequirePromotionalText] [-RequireWhatsNew] [-TokenLifetimeMinutes <Int32>] -VersionString <String> [<CommonParameters>]#Parameter set:
All Parameter SetsParameters
- AppId String
- App Store Connect app id.
- BuildNumber String
- Expected selected build number.
- IssuerId String
- Issuer ID from App Store Connect API keys.
- KeyId String
- Key ID associated with the private key.
- Locale String
- Localization locale to check.
- MinimumScreenshotsPerSet Int32
- Minimum screenshot count for each required display type.
- NoRequireCompleteScreenshots SwitchParameter
- Do not require checked screenshot assets to be COMPLETE.
- NoRequireDescription SwitchParameter
- Do not require description.
- NoRequireKeywords SwitchParameter
- Do not require keywords.
- NoRequireScreenshots SwitchParameter
- Do not require screenshots.
- NoRequireSelectedBuild SwitchParameter
- Require a selected build relationship. Enabled by default.
- NoRequireSupportUrl SwitchParameter
- Do not require support URL.
- NoRequireValidBuild SwitchParameter
- Do not require the matched build to be VALID and not expired.
- Platform ApplePlatform
- Apple platform for the App Store version.
- Possible values:
iOS,iPadOS,macOS,tvOS,watchOS,visionOS - PrivateKey String
- Private key text in PEM format.
- PrivateKeyPath String
- Path to a private key file in PEM format.
- RequiredScreenshotDisplayTypes String[]
- Screenshot display types that must have screenshots.
- RequireMarketingUrl SwitchParameter
- Require marketing URL.
- RequirePromotionalText SwitchParameter
- Require promotional text.
- RequireWhatsNew SwitchParameter
- Require what's new / release notes text.
- TokenLifetimeMinutes Int32
- Token lifetime in minutes, up to 20.
- VersionString String
- App Store marketing version to check.
Outputs
PowerForge.AppStoreConnectReleaseReadinessResult