https://github.com/Apple-Actions/download-provisioning-profiles

Github Action for downloading provisioning profiles from Apple AppStore Connect
https://github.com/Apple-Actions/download-provisioning-profiles

actions apple github-actions

Last synced: 26 days ago
JSON representation

Github Action for downloading provisioning profiles from Apple AppStore Connect

• Host: GitHub
• URL: https://github.com/Apple-Actions/download-provisioning-profiles
• Owner: Apple-Actions
• License: mit
• Created: 2020-01-28T10:23:21.000Z (over 5 years ago)
• Default Branch: master
• Last Pushed: 2024-05-10T08:07:26.000Z (12 months ago)
• Last Synced: 2024-11-04T14:03:38.867Z (6 months ago)
• Topics: actions, apple, github-actions
• Language: TypeScript
• Size: 1.09 MB
• Stars: 74
• Watchers: 11
• Forks: 37
• Open Issues: 7
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# GitHub Action to download and install Provisioning Profiles

[![License](https://img.shields.io/badge/license-MIT-green.svg?style=flat)](LICENSE)

[![PRs welcome!](https://img.shields.io/badge/PRs-welcome-brightgreen.svg)](CONTRIBUTING.md)

## Getting Started (can be the same key as the [upload testflight action](https://github.com/Apple-Actions/upload-testflight-build/blob/master/README.md#getting-started))

* Create an `App Store Connect` profile following [these instructions](https://developer.apple.com/help/account/provisioning-profiles/create-a-development-provisioning-profile/)

* Create an `App Store Connect API Key` ([these instructions](https://developer.apple.com/documentation/appstoreconnectapi/creating-api-keys-for-app-store-connect-api) with the role `App Manager`)

* Download the certificate (must be done upon creation and will be called `ios_distribution.cer`)

* Copy the `.p8` ( `cat AuthKey_.p8 | pbcopy` )

* Add it as a secret called `APPSTORE_API_PRIVATE_KEY` and add `Key ID` as a variable called `APPSTORE_API_KEY_ID`

* Add `Issuer ID` as a variable called `APPSTORE_ISSUER_ID` ([found here](https://appstoreconnect.apple.com/access/integrations/api))

## Usage

```yaml

- name: 'Download Provisioning Profiles'

  uses: apple-actions/download-provisioning-profiles@v4

  with:

    bundle-id: 'com.example.App'

    profile-type: 'IOS_APP_STORE'

    issuer-id: ${{ vars.APPSTORE_ISSUER_ID }}

    api-key-id: ${{ vars.APPSTORE_KEY_ID }}

    api-private-key: ${{ secrets.APPSTORE_PRIVATE_KEY }}

```

## Additional Arguments

See [action.yml](action.yml) for more details.

## Outputs

The action outputs an array of JSON objects to the action output named `profiles`.  You can access and manipulate this data using [workflow expressions](https://help.github.com/en/actions/automating-your-workflow-with-github-actions/contexts-and-expression-syntax-for-github-actions#steps-context).

## Contributing

We welcome your interest in contributing to this project. Please read the [Contribution Guidelines](CONTRIBUTING.md) for more guidance.

## License

Any contributions made under this project will be governed by the [MIT License](LICENSE).