Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/akiojin/publish-testflight-github-action

Last synced: 8 days ago
JSON representation

Host: GitHub
URL: https://github.com/akiojin/publish-testflight-github-action
Owner: akiojin
License: mit
Created: 2022-09-26T11:28:15.000Z (about 2 years ago)
Default Branch: main
Last Pushed: 2024-10-27T02:37:03.000Z (22 days ago)
Last Synced: 2024-10-27T03:32:31.595Z (22 days ago)
Language: TypeScript
Size: 598 KB
Stars: 0
Watchers: 2
Forks: 0
Open Issues: 7
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

README

        # publish-testflight-github-action

GitHub Action to deliver ipa files to TestFlight.

## Requirement

### fastlane

You will need to install [fastlane](https://docs.fastlane.tools/).

```sh

brew install fastlane

```

## API Key

An API key is a value required to use the App Store Connect API.

This key can be created at [App Store Connect](https://appstoreconnect.apple.com/access/api).

![API Key](API_Key.png)

The API key was created through App Store Connect and the downloaded file (*.p8) should look like this

```txt

-----BEGIN PRIVATE KEY-----

MIGTAgEAMBMGByqGSM49AgEGCCqGSM49AwEHBHkwdwIBAQQgqRVRAdjtVB+K2T7R

Jzl3TJ3ninFWn7cMU8C/KaJtb1GgCgYIKoZIzj0DAQehRANCAAS2yyN09ebrFtlD

umqAQ1WJTrpbcWhHnoGNrdVk2waj2eRL1ThZoBYkQUqkc9Qo11prUiETlfh+3/Lv

........

-----END PRIVATE KEY-----

```

Set this value to the GitHub Actions secret.

![Secrets](Secrets.png)

## Usage

### Simple usage

```yml

- uses: akiojin/[email protected]

  with:

    ipa-path: 

    api-key: ${{ secrets.APPLE_STORE_CONNECT_API_KEY }}

    issuer-id: ${{ secrets.APPLE_STORE_CONNECT_ISSUER_ID }}

    key-id: ${{ secrets.APPLE_STORE_CONNECT_KEY_ID }}

```

## Arguments

|Name|Required|Type|Default|Description|

|:--|:--|:--|:--|:--|

|`api-key`|`false`|`string`||The App Connect API Key. If `api-key-path` is not specified, this value must be specified, but if `api-key-path` is specified and this value is set, the contents of `api-key-path` will be overwritten with this value.|

|`api-key-path`|`false`|`string`||The App Connect API Key path. If `api-key` is not specified, this value must be specified.|

|`ipa-path`|`true`|`string`||Path to the IPA file to be delivered by TestFlight.|

|`issuer-id`|`true`|`string`||Issuer ID|

|`key-id`|`true`|`string`||Key ID|

## License

Any contributions made under this project will be governed by the [MIT License](https://github.com/akiojin/publish-testflight-github-action/blob/main/LICENSE).