release-to-app-store
v0.0.4
Published
The release-to-app-store npm package streamlines the process of releasing mobile applications by leveraging the App Store Connect API and Google Play Developer API
Downloads
5
Maintainers
Readme
Release-to-App-Store
The release-to-app-store
npm package streamlines the process of releasing mobile applications by leveraging the App Store Connect API and Google Play Developer API
Installation
Install release-to-app-store
globally using npm, yarn, or pnpm.
# npm
npm install -g release-to-app-store
# yarn
yarn global add release-to-app-store
# pnpm
pnpm add -g release-to-app-store
Configuration - Setting up API Keys
Before using the commands, make sure to set up the API keys required for authentication. Follow the steps below to configure the necessary keys:
App Store Connect
To interact with App Store Connect, follow these steps:
- Obtain the necessary keys -
issuerId
,keyId
, andauthKey
from App Store Connect. - Use the
ios-key
command to generate the encoded key.
authKey="-----BEGIN PRIVATE KEY-----
your key
-----END PRIVATE KEY-----"
#set you key
iosKey=$(npx release-to-app-store ios-key --issuerId 89a6de7b-ef0e-4ge3-e053-5bfac7c11a4d1 --keyId UCK38SDNK --authKey $authKey)
#make an relase and add it to review
npx release-to-app-store make-ios-release --key $iosKey --appId 1586363601 --version 1.0.0 --buildNumber 1 --addToAppReview true
Google Play
To interact with Google Play, follow these steps:
- Visit the Google Play Console and create an API key.
- Save your Google Play key as a JSON file.
- Use the
--path
option with theandroid-key
command to specify the path to your Google Play key file.
#set you key
androidKey=$(npx release-to-app-store android-key --path ./google-play-key.json)
#make an relase
npx release-to-app-store make-android-release --key $androidKey --appId test.my.app --version 1.0.0 --buildNumber 1
Available Commands
make-ios-release
Options
-k, --key <key>
: Key for authentication.-a, --appId <appId>
: App ID.-v, --version <version>
: Version.-b, --build <build>
: Build number.-p, --pathToReleaseText <pathToReleaseText>
-r, --addToAppReview <addToAppReview>
: Add to app review.
make-android-release
Options
-k, --key <key>
: Key for authentication.-a, --appId <appId>
: App ID.-v, --version <version>
: Version.-b, --build <build>
: Build number.-p, --pathToReleaseText <pathToReleaseText>
Example Release Text
example for the pathToReleaseText
releaseText.json
{
"en-US": "Bug fixes and enhancements.",
"nl-NL": "Bug fixes en verbeteringen.",
"fr-FR": "Corrections de bugs et améliorations.",
"de-DE": "Fehlerbehebungen und Verbesserungen.",
"es-ES": "Corrección de errores y mejoras."
}
This project is licensed under the MIT License.