Skip to content

Commit

Permalink
docs: update release instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
osy committed Feb 28, 2024
1 parent 8b1b2b2 commit 1c4fbc9
Showing 1 changed file with 8 additions and 3 deletions.
11 changes: 8 additions & 3 deletions Documentation/Release.md
Original file line number Diff line number Diff line change
Expand Up @@ -83,14 +83,15 @@ Below is a summary of all the variables and secrets used by GitHub Actions in th
|`PERSONAL_ACCESS_TOKEN` |GitHub personal token with permission for `repository_dispatch` |
|`SIGNING_CERTIFICATE_P12_DATA` |Base64 encoded PKCS#12 format containing certificates and private keys for signing |
|`SIGNING_CERTIFICATE_PASSWORD` |Password of the PKCS#12 file |
|`SIGNING_USERNAME` |App Store Connect username for notarizing and submission |
|`SIGNING_PASSWORD` |App Store Connect ["app-specific password"][3] |
|`CONNECT_KEY` |App Store Connect API key for notarizing and submission (base64 encoded .p8) |

|Variable |Description |
|---------------------------------|-----------------------------------------------------------------------------------|
|`DISPATCH_ALTSTORE_REPO_NAME` |`username/repo` path to a [altstore-github][1] repository |
|`DISPATCH_CYDIA_REPO_NAME` |`username/repo` path to a [silica-package-github][2] repository |
|`SIGNING_TEAM_ID` |Team ID associated with signing certificates |
|`CONNECT_ISSUER_ID` |App Store Connect API issuer id |
|`CONNECT_KEY_ID` |App Store Connect API key id |
|`PROFILE_DATA` |Base64 encoded provisioning profile of main application |
|`PROFILE_UUID` |UUID of provisioning profile above |
|`HELPER_PROFILE_DATA` |Base64 encoded provisioning profile of QEMUHelper |
Expand All @@ -103,14 +104,18 @@ Below is a summary of all the variables and secrets used by GitHub Actions in th
|`APP_STORE_HELPER_PROFILE_UUID` |UUID of provisioning profile above |
|`APP_STORE_LAUNCHER_PROFILE_DATA`|Base64 encoded provisioning profile of QEMULauncher for App Store submission |
|`APP_STORE_LAUNCHER_PROFILE_UUID`|UUID of provisioning profile above |
|`IOS_REMOTE_PROFILE_DATA` |Base64 encoded provisioning profile of iOS Remote for App Store submission |
|`IOS_REMOTE_PROFILE_UUID` |UUID of provisioning profile above |
|`IOS_SE_PROFILE_DATA` |Base64 encoded provisioning profile of iOS SE for App Store submission |
|`IOS_SE_PROFILE_UUID` |UUID of provisioning profile above |
|`IS_SELF_HOSTED_RUNNER` |Set to `true` to use a self hosted macOS runner set up by the owner |

### Signing for release

The following certificates (and associated private keys) must be exported from Keychain as a PKCS#12 file (Cmd+click to select multiple and right click to export).

* Developer ID Application
* 3rd Party Mac Developer Application (Mac App Store)
* 3rd Party Mac Developer Application (Mac App Store) or Apple Distribution
* 3rd Party Mac Developer Installer (Mac App Store)

Give a password when prompted and save it to the repository secret `SIGNING_CERTIFICATE_PASSWORD`. Then, in Terminal, convert the PKCS#12 file to Base64 and copy it: `cat Certificates.p12 | base64 | pbcopy` and paste it to `SIGNING_CERTIFICATE_P12_DATA`.
Expand Down

0 comments on commit 1c4fbc9

Please sign in to comment.