From 9c82a5c7f24b7de3ebe0aab839339eb91a5d5937 Mon Sep 17 00:00:00 2001 From: Omar Masad Date: Fri, 25 Mar 2022 19:59:06 +0400 Subject: [PATCH 1/2] Update README.md --- README.md | 52 +++++++++++++++++++++++----------------------------- 1 file changed, 23 insertions(+), 29 deletions(-) diff --git a/README.md b/README.md index c74dd40..f392fa7 100644 --- a/README.md +++ b/README.md @@ -4,15 +4,13 @@ This is the official CLI (ta-cli) for [TestApp.io](https://testapp.io) app distribution to upload your Android (APK) and iOS (IPA) directly from this command line and notifying your team members about the new releases if you enable it. -🎉 Join our [Slack](https://join.slack.com/t/testappio/shared_invite/zt-pvpoj3l2-epGYwGTaV3~3~0f7udNWoA) channel for feedback and support! - ![Screen Shot 2021-06-05 at 12 50 14 AM](https://user-images.githubusercontent.com/3076722/120862504-1f8e7f80-c59a-11eb-93ca-71f677855020.png) ## Installation #### MacOS & Linux -```bash +```sh curl -Ls https://github.com/testappio/cli/releases/latest/download/install | bash ``` @@ -22,7 +20,7 @@ Currently, we are not supporting `ta-cli config` for Windows. Download latest [windows release](https://github.com/testappio/cli/releases/latest/download/ta-cli_windows.zip) and unzip it -``` +```sh ta-cli.exe publish --api_token=[Your API Token] --app_id=[Your AppID] --release=android --apk=C:/path/to/app.apk ``` @@ -32,7 +30,7 @@ ta-cli.exe publish --api_token=[Your API Token] --app_id=[Your AppID] --release= You can use `vim` if installed `vim $HOME/.ta-cli.json` -```bash +```json { "api_token": "Your API Token", "app_id": "Your App ID", @@ -48,7 +46,7 @@ You can use `vim` if installed `vim $HOME/.ta-cli.json` 2. From your terminal navitage to the extracted folder -``` +```sh ta-cli.exe publish ``` @@ -58,52 +56,48 @@ Navigate to [latest releases](https://github.com/testappio/cli/releases) and dow ## Configuration -```bash +```sh ta-cli config ``` -> `api_token`: You can get it from https://portal.testapp.io/settings/api-credentials - -> `app_id`: You can get it from your app page in https://portal.testapp.io/apps - -> `release`: It can be either `both` or `android` or `ios` - -> `apk`: /user/path/to/app.apk (if you select release `both` or `android`) - -> `ipa`: /user/path/to/app.ipa (if you select release `both` or `ios`) - -> `release_notes`: Manually add the release notes to be displayed for the testers - -> `git_release_notes`: Collect release notes from the latest git commit message to be displayed for the testers: `true` or `false` - -> `include_git_commit_id`: Iclude the last commit ID in the release notes (works with both release notes option): `true` or `false` - -> `notify`: Send notificaitons to your team members about this release: `true` or `false` +| Key | Description | Env Var(s) | Default | +| ----------------- | ------------------------------------------------------------------------------------------------------- | --------------------------- | ------- | +| api_token | You can get it from https://portal.testapp.io/settings/api-credentials | TESTAPPIO_API_TOKEN | | +| app_id | You can get it from your app page at [https://portal.testapp.io/apps](https://portal.testapp.io/apps?select-for-integrations) | TESTAPPIO_APP_ID | | +| release | It can be either both or Android or iOS | TESTAPPIO_RELEASE | | +| apk_file | Path to the Android APK file | TESTAPPIO_ANDROID_PATH | | +| ipa_file | Path to the iOS IPA file | TESTAPPIO_IOS_PATH | | +| release_notes | Manually add the release notes to be displayed for the testers | TESTAPPIO_RELEASE_NOTES | | +| git_release_notes | Collect release notes from the latest git commit message to be displayed for the testers: true or false | TESTAPPIO_GIT_RELEASE_NOTES | true | +| git_commit_id | Include the last commit ID in the release notes (works with both release notes options): true or false | TESTAPPIO_GIT_COMMIT_ID | false | +| notify | Send notifications to your team members about this release: true or false | TESTAPPIO_NOTIFY | false | The default configuration file will be at `$HOME/.ta-cli.json` ## Publish -```bash +```sh ta-cli publish ``` To override any value in the config: -```bash +```sh ta-cli publish --release=android --release_notes="my release notes" --include_git_commit_id=true ``` For more info about list of options: -```bash +```sh ta-cli publish -h ``` ## Feedback & Support -Join our [Slack](https://join.slack.com/t/testappio/shared_invite/zt-pvpoj3l2-epGYwGTaV3~3~0f7udNWoA) channel for feedback and support or you can contact us at support@testapp.io and we'll gladly help you out! +Developers built [TestApp.io](https://testapp.io) to solve the pain of app distribution for mobile app development teams. + +Join our [Slack](https://join.slack.com/t/testappio/shared_invite/zt-pvpoj3l2-epGYwGTaV3~3~0f7udNWoA) channel for feedback and support. ---- +Check out our [Help Center](https://help.testapp.io/) for more info and other integrations. Happy releasing 🎉 From ed249eaa2cb824d623377e30bfcbac6cfe7d4232 Mon Sep 17 00:00:00 2001 From: Omar Masad Date: Sun, 27 Mar 2022 17:23:47 +0400 Subject: [PATCH 2/2] Update README.md --- README.md | 41 +++++++++++++++++++++++++++-------------- 1 file changed, 27 insertions(+), 14 deletions(-) diff --git a/README.md b/README.md index f392fa7..20da9c0 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ # [TestApp.io](https://testapp.io/) CLI -> This is in BETA mode. Your feedback is highly appreciated. +> BETA mode. Your feedback is highly appreciated. This is the official CLI (ta-cli) for [TestApp.io](https://testapp.io) app distribution to upload your Android (APK) and iOS (IPA) directly from this command line and notifying your team members about the new releases if you enable it. @@ -36,7 +36,7 @@ You can use `vim` if installed `vim $HOME/.ta-cli.json` "app_id": "Your App ID", "release": "android", "apk": "/user/path/to/android/app.apk", - "ipa": "", + "ipa": "/user/path/to/ios/app.ipa", "release_notes": "", "git_release_notes": true, "git_commit_id": false, @@ -60,17 +60,19 @@ Navigate to [latest releases](https://github.com/testappio/cli/releases) and dow ta-cli config ``` -| Key | Description | Env Var(s) | Default | -| ----------------- | ------------------------------------------------------------------------------------------------------- | --------------------------- | ------- | -| api_token | You can get it from https://portal.testapp.io/settings/api-credentials | TESTAPPIO_API_TOKEN | | -| app_id | You can get it from your app page at [https://portal.testapp.io/apps](https://portal.testapp.io/apps?select-for-integrations) | TESTAPPIO_APP_ID | | -| release | It can be either both or Android or iOS | TESTAPPIO_RELEASE | | -| apk_file | Path to the Android APK file | TESTAPPIO_ANDROID_PATH | | -| ipa_file | Path to the iOS IPA file | TESTAPPIO_IOS_PATH | | -| release_notes | Manually add the release notes to be displayed for the testers | TESTAPPIO_RELEASE_NOTES | | -| git_release_notes | Collect release notes from the latest git commit message to be displayed for the testers: true or false | TESTAPPIO_GIT_RELEASE_NOTES | true | -| git_commit_id | Include the last commit ID in the release notes (works with both release notes options): true or false | TESTAPPIO_GIT_COMMIT_ID | false | -| notify | Send notifications to your team members about this release: true or false | TESTAPPIO_NOTIFY | false | +| Key | Description | Env Var(s) | Default | +| ----------------- | ----------------------------------------------------------------------------------------------------------------------------- | --------------------------- | ------------------ | +| config | path to your ta-cli.json config file [Optional] | | $HOME/.ta-cli.json | +| api_token | You can get it from https://portal.testapp.io/settings/api-credentials | TESTAPPIO_API_TOKEN | | +| app_id | You can get it from your app page at [https://portal.testapp.io/apps](https://portal.testapp.io/apps?select-for-integrations) | TESTAPPIO_APP_ID | | +| release | It can be either both or Android or iOS | TESTAPPIO_RELEASE | | +| apk_file | Path to the Android APK file | TESTAPPIO_ANDROID_PATH | | +| ipa_file | Path to the iOS IPA file | TESTAPPIO_IOS_PATH | | +| release_notes | Manually add the release notes to be displayed for the testers | TESTAPPIO_RELEASE_NOTES | | +| git_release_notes | Collect release notes from the latest git commit message to be displayed for the testers: true or false | TESTAPPIO_GIT_RELEASE_NOTES | true | +| git_commit_id | Include the last commit ID in the release notes (works with both release notes options): true or false | TESTAPPIO_GIT_COMMIT_ID | false | +| notify | Send notifications to your team members about this release: true or false | TESTAPPIO_NOTIFY | false | + The default configuration file will be at `$HOME/.ta-cli.json` @@ -83,7 +85,18 @@ ta-cli publish To override any value in the config: ```sh -ta-cli publish --release=android --release_notes="my release notes" --include_git_commit_id=true +ta-cli publish --release=android --release_notes="my release notes" --git_release_notes=true --git_commit_id=true +``` + +## Config path +Default directories in order: + +1. input path from `--config=` +2. .ta-cli.json +3. $HOME/.ta-cli.json + +```sh +ta-cli publish --config=ta-cli.json ``` For more info about list of options: