apple-actions/Xcode Build

Build, archive, and export an Xcode project or workspace with xcodebuild.

View on GitHub

Trust Signals

Scorecard Score
not yet scored
Maintenance Recency
Stale
License
None
namedescriptionrequireddefault
workspacePath to the Xcode workspace (.xcworkspace). Mutually exclusive with `project`.no
projectPath to the Xcode project (.xcodeproj). Mutually exclusive with `workspace`.no
schemeScheme to build.yes
configurationBuild configuration (e.g. Debug, Release).noRelease
sdkSDK to build against (e.g. iphoneos, iphonesimulator, macosx).no
destinationDestination specifier (e.g. "generic/platform=iOS").no
actionxcodebuild action: build, archive, test, build-for-testing, clean.nobuild
archive-pathOutput path for the .xcarchive. Required when `action` is `archive`.no
export-options-plistPath to an ExportOptions.plist. When provided after an archive, the archive is exported to `export-path`.no
export-pathDirectory to export the archive to when `export-options-plist` is provided. Defaults to `<result-bundle-dir>/<scheme>.ipa`.no
derived-data-pathDerived data directory.no.build/DerivedData
result-bundle-pathPath for the .xcresult bundle. Defaults to `.build/Artifacts/<scheme>.xcresult`.no
build-numberValue passed to xcodebuild as CURRENT_PROJECT_VERSION.no
build-settingsAdditional xcodebuild build settings as KEY=VALUE pairs, one per line.no
extra-argumentsAdditional arguments passed verbatim to xcodebuild (shell-quoted).no
output-formatterCommand to pipe xcodebuild output through (e.g. xcbeautify, xcpretty). Set to an empty string to disable. The default uses xcbeautify's github-actions renderer so compile errors and warnings surface as inline PR annotations.noxcbeautify --renderer github-actions
log-pathPath to write the raw xcodebuild log. Defaults to `.build/<scheme>.log`.no
parallelize-targetsPass -parallelizeTargets to xcodebuild.notrue
show-build-timing-summaryPass -showBuildTimingSummary to xcodebuild.notrue
disable-automatic-package-resolutionPass -disableAutomaticPackageResolution to xcodebuild.notrue
zip-result-bundleZip the .xcresult bundle next to itself as <result-bundle-path>.zip after the build.nofalse
zip-archiveZip the .xcarchive next to itself as <archive-path>.zip after archiving.nofalse
working-directoryWorking directory to run xcodebuild in.no
namedescription
archive-pathResolved path to the produced .xcarchive, if any.
export-pathResolved directory containing the exported IPA, if any.
ipa-pathPath to the first .ipa found inside `export-path`, if any.
result-bundle-pathResolved path to the .xcresult bundle.
log-pathResolved path to the raw xcodebuild log.