streetwriters / appstore-connect-app-version

Github Action for getting the latest and the previous application version from the App Store Connect

App Store Connect Latest & Previous Versions Action

This action can be used to get the latest and the previous application version from the App Store. It calls appStoreVersions request from the App Store Connect API.

Prerequisites

To send an API request to the App Store Connect you must generate a Json Web Token with ES256 encryption. You can generate this token by yourself and then pass it to the action or you can generate it automatically.

Get App Id

To get the app id you can either navigate to your app in the App Store with your browser and check your url (https://apps.apple.com/by/app/{app-name}/id{app-id}) or navigate to your app in the App Store Connect, then open App Information at the left column and find Apple ID there (under the General Information). This parameter is required to identify your application.

API Key Creation

1. First of all navigate to the App Store Connect.
2. Open Users and Access.
3. Select Keys tab.
4. Tap the "+" button.
5. Enter the name of your key (e.g. your-app-name-api-key) and select the desired role (e.g. Developer).
6. A new key will appear in your Keys list.
7. Tap "Download API Key" to download the AuthKey_{key-id}.p8 file.
   Note: You won't be able to download it afterwards.
8. Copy Issuer ID and Key ID on the same page.
   Note: You will be able to copy them afterwards.

Note: It's suggested to store the sensitive information (like json web token, private key, key id and issuer id) as Github Secrets (please check also how to store files as secrets).

Json Web Token Generation

If you want to generate JWT manually, just refer to the Generating Tokens for API Requests article, then use something like token.dev to create a token. All you should do is to pass app-id and json-web-token as the action's parameters.

In order to generate JWT automatically, you can just provide app-id, issuer-id and your private key. The private key can be provided as a raw string (private-key-raw), as a Base64 encoded *.p8 file (private-key-p8-base64) or as a path to *.p8 file (private-key-p8-path).

The priority of the parameters (which one will be used first) is the following: json-web-token > private-key-raw > private-key-p8-path > private-key-p8-base64.

Usage

You can use this action simply by writing something like this:

on: [push]

jobs:
  job_test:
    runs-on: ubuntu-latest
    name: Job for action testing
    steps:
      - name: Checkout
        uses: actions/checkout@v3

      - name: Get App Store Version
        id: appstore_version
        uses: ilyalehchylin/[email protected]
        with:
          app-id: ${{ secrets.APP_ID }}
          key-id: ${{ secrets.KEY_ID }}
          issuer-id: ${{ secrets.ISSUER_ID }}
          json-web-token: ${{ secrets.JSON_WEB_TOKEN }}
          private-key-raw: ${{ secrets.PRIVATE_KEY_RAW }}
          private-key-p8-base64: ${{ secrets.PRIVATE_KEY_FILE_BASE64 }}
          private-key-p8-path: ./AuthKey.p8
          platform: "IOS"

      - name: Get results
        run: |
          echo "App Store latest version: ${{ steps.appstore_version.outputs.app-version-latest }}"
          echo "App Store latest state: ${{ steps.appstore_version.outputs.app-state-latest }}"
          echo "App Store latest release type: ${{ steps.appstore_version.outputs.app-release-type-latest }}"
          echo "App Store latest creation date: ${{ steps.appstore_version.outputs.version-created-date-latest }}"
          echo "App Store previous version: ${{ steps.appstore_version.outputs.app-version-previous }}"
          echo "App Store previous state: ${{ steps.appstore_version.outputs.app-state-previous }}"
          echo "App Store previous release type: ${{ steps.appstore_version.outputs.app-release-type-previous }}"
          echo "App Store previous creation date: ${{ steps.appstore_version.outputs.version-created-date-previous }}"

You can find some samples here.

Action Inputs

There are no default values for the inputs.

Input	Required	Description
app-id	true	App Store application identifier.
json-web-token	false	JSON Web Token for the App Store API request.
key-id	false	Private key ID from App Store Connect.
issuer-id	false	Issuer ID from the API Keys page in App Store Connect.
private-key-p8-path	false	Private key file downloaded from the API Keys page in App Store Connect (*.p8 file).
private-key-p8-base64	false	Private key downloaded from the API Keys page in App Store Connect (*.p8 file) in Base64 format.
private-key-raw	false	Raw private key downloaded from the API Keys page in App Store Connect.
platform	false	Platform to get version information for (possible values: IOS, MAC_OS, TV_OS)

Action Outputs

Output	Description
app-version-latest	Latest app version, e.g. 1.0.1.
app-state-latest	Latest app state. Possible values.
app-release-type-latest	Latest app release type. Possible values: MANUAL, AFTER_APPROVAL, SCHEDULED.
version-created-date-latest	Latest app version created date, e.g. 2022-06-08T02:47:00-07:00.
app-version-previous	Previous app version, e.g. 1.0.0.
app-state-previous	Previous app state. Possible values.
app-release-type-previous	Previous app release type. Possible values: MANUAL, AFTER_APPROVAL, SCHEDULED.
version-created-date-previous	Previous app version created date. 2022-04-29T10:03:06-07:00.

Contributing

Contributors are welcome! See CONTRIBUTING.md for additional instructions.