XCode-Deploy with Secrets 1.7

This action will archive, export, and upload your project or workspace to App Store Connect (TestFlight). It is designed to run on a containerized VM, such as a GitHub Hosted Runner. If self-hosting, some of these steps may be unnecessary or redundant.

Inputs

xcode-version

The version of XCode to use, in SemVer. Default is latest stable release: xcode-latest. See also setup-xcode.

configuration

The configuration to archive. Default is Release. See also xcodebuild's -configuration.

scheme

The scheme to archive. If left blank, the action will search the project or workspace file for a default scheme. See also xcodebuild's -scheme.

path-to-export-options

The path to the ExportOptions.plist file, required for -exportArchive. Will default to ExportOptions.plist in the ${{ github.workspace }} directory. See also xcodebuild's -exportArchive.

path-to-secrets

The path to the secrets.json file. If left empty, the file creation portion of the action will not run.

json-for-secrets

JSON string structured as a list of variables and values. If left empty, file creation portion of the action will not run.

update-build

A boolean value that will set the version-number to the commit depth. If false, nothing happens. See also agvtool's -new-version.

install-pods

A boolean value that will run pod install if true. If false, nothing happens.

resolve-package-dependencies

A boolean value that will run xcodebuild -resolvePackageDependencies -clonedSourcePackagesDirPath . if true. If false, nothing happens.

distribution-certificate-p12

The base64 representation of your Apple/iOS Distribution Certificate and private key pair.

distribution-certificate-password

The password to unlock the Distribution Certificate and private key pair.

app-store-provisioning-profile

The base64 representation of your App Store Provisioning Profile.

auth-key-id

The ID of the Authentication Key provided by App Store Connect.

auth-key-issuer-id

The Issuer ID provided by App Store Connect.

auth-key-p8

The base64 representation of the private key provided by App Store Connect.

Additionally, an ExportOptions.plist file must be included in the repository at the location and filename that matches path-to-export-options. You can generate one of these by doing a local export in XCode and then copy it into your repository, or use /usr/libexec/PlistBuddy.

Sample Usage

- name: Deploy
  uses: dppeak/xcode-deploy-with-secrets@v1.7
  with:
    xcode-version: '14.0'
    configuration: 'Release'
    scheme: 'MyScheme'
    path-to-export-options: 'ExportOptions.plist'
    path-to-secrets: './somePath/secrets.json'
    json-for-secrets: '[{"FirstCustomKey": "Some new Value"}, {"SecondCustomKey": "Another Value"}]'
    update-build: true
    install-pods: false
    resolve-package-dependencies: true
    distribution-certificate-p12: ${{ secrets.DISTRIBUTION_CERTIFICATE_P12 }}
    distribution-certificate-password: ${{ secrets.DISTRIBUTION_CERTIFICATE_PASSWORD }}
    app-store-provisioning-profile: ${{ secrets.APPSTORE_PROVISIONING_PROFILE}}
    auth-key-id: ${{ secrets.AUTH_KEY_ID }}
    auth-key-issuer-id: ${{ secrets.AUTH_KEY_ISSUER_ID }}
    auth-key-p8: ${{ secrets.AUTH_KEY_P8 }}

See action.yml for more details.

Contributions

The original composite action was written by Vincent Frascello, but uses actions by other open-source contributors:

Maxim Lobanov

Oliver Jones

Florian Fried

Akio Jinsenji

Github Actions Team

David Peak

License

Any contributions made under this project will be governed by the MIT License.