ZReviewTender

https://github.com/zhgchgli/zreviewtender
Admin
ZReviewTender is an open-source tool that automatically fetches app reviews from the App Store and...
Tokens:24,028
Snippets:172
Trust Score:9
License:MIT
Update:2 weeks ago
Show doc for...
Tokens:
Raw
### Install and run ZReviewTender

Source: https://github.com/zhgchgli/zreviewtender/blob/main/README.md

Commands to clone the repository, set up the Ruby environment, install dependencies, and execute the ZReviewTender binary.

```bash
git clone https://github.com/ZhgChgLi/ZReviewTender.git
cd ZReviewTender
bundle install
bundle exec bin/ZReviewTender
```

--------------------------------

### Complete combination example for android.yml

Source: https://github.com/zhgchgli/zreviewtender/blob/main/quickstart.md

Complete example configuration for an Android app review pipeline, including FilterProcessor, GoogleTranslateProcessor, and SlackProcessor. Shows the required platform, packageName, keyFilePath, playConsoleDeveloperAccountID, and playConsoleAppID fields. The SlackProcessor's slackInCommingWebHookURL is deprecated.

```yaml
platform: 'android'
packageName: '' # Android App Package Name
keyFilePath: '' # Google Android Publisher API Service Account Credential .json File Path
playConsoleDeveloperAccountID: '' # Google Console Developer Account ID
playConsoleAppID: '' # Google Console App ID
processors:
    - FilterProcessor:
        class: "FilterProcessor"
        enable: true # enable
        keywordsInclude: [] # keywords you want to filter out
        ratingsInclude: [] # ratings you want to filter out
        territoriesInclude: [] # territories you want to filter out (territory for Apple e.g. TWN)
    - GoogleTranslateProcessor: # Google Translate Processor, will translate review text to your language, you can remove whole block if you don't need it.
        class: "GoogleTranslateProcessor"
        enable: true # enable
        googleTranslateAPIKeyFilePath: '' # Google Translate API Service Account Credential .json File Path
        googleTranslateTargetLang: 'zh-TW' # Translate to what Language
        googleTranslateTerritoriesExclude: ["zh-Hant","zh-Hans"] # Review origin Territory (language) that you don't want to translate. (language for android e.g. zh-Hant, en)
    - SlackProcessor: # Slack Processor, resend App Review to Slack.
        class: "SlackProcessor"
        enable: true # enable
        slackTimeZoneOffset: "+08:00" # Review Created Date TimeZone
        slackAttachmentGroupByNumber: "1" # 1~100, how many review messages in 1 slack message.
        slackBotToken: "" # Slack Bot Token, send slack message through Slack Bot.
        slackBotTargetChannel: "" # Slack Bot Token, send slack message through Slack Bot. (recommended, first priority)
        slackInCommingWebHookURL: "" # Slack In-Coming WebHook URL, Send slack message through In-Coming WebHook, not recommended, deprecated.
```

--------------------------------

### Ruby: Install gem

Source: https://github.com/zhgchgli/zreviewtender/blob/main/README.md

Installs the ZReviewTender gem using RubyGems. Requires Ruby and Bundler to be installed.

```bash
gem install ZReviewTender
```

--------------------------------

### Configure android.yml for Android

Source: https://github.com/zhgchgli/zreviewtender/blob/main/quickstart.md

Configuration for the Android platform. Fill in the placeholders with values from Google Play Console and Slack setup. The SlackProcessor is enabled by default and sends review messages to Slack.

```yaml
platform: 'android'
packageName: 'Package Name' # Android App Package Name
keyFilePath: './config/XXXX-XXXX.json' # Google Android Publisher API Service Account Credential .json File Path
playConsoleDeveloperAccountID: 'Developer ID' # Google Console Developer Account ID
playConsoleAppID: 'App ID' # Google Console App ID
processors:
- SlackProcessor: # Slack Processor, resend App Review to Slack.
        class: "SlackProcessor"
        enable: true # enable
        slackTimeZoneOffset: "+08:00" # Review Created Date TimeZone
        slackAttachmentGroupByNumber: "1" # 1~100, how many review message in 1 slack message.
        slackBotToken: "Slack App Bot User OAuth Token" # Slack Bot Token, send slack message through Slack Bot.
        slackBotTargetChannel: "Target Channel ID" # Slack Bot Token, send slack message through Slack Bot. (recommended, first priority)
        slackInCommingWebHookURL: "" # Slack In-Coming WebHook URL, Send slack message through In-Coming WebHook, not recommended, deprecated.
```

--------------------------------

### Configure apple.yml for iOS

Source: https://github.com/zhgchgli/zreviewtender/blob/main/quickstart.md

Configuration for the Apple (iOS) platform. Fill in the placeholders with values from App Store Connect and Slack setup. The SlackProcessor is enabled by default and sends review messages to Slack.

```yaml
platform: 'apple'
appStoreConnectP8PrivateKeyFilePath: './config/AuthKey_XXXXXXXXXX.p8' # APPLE STORE CONNECT API PRIVATE .p8 KEY File Path
appStoreConnectP8PrivateKeyID: 'Private Key ID' # APPLE STORE CONNECT API PRIVATE KEY ID
appStoreConnectIssueID: 'Issuer ID' # APPLE STORE CONNECT ISSUE ID
appID: 'App ID' # APP ID
processors:
    - SlackProcessor: # Slack Processor, resend App Review to Slack.
        class: "SlackProcessor"
        enable: true # enable
        slackTimeZoneOffset: "+08:00" # Review Created Date TimeZone
        slackAttachmentGroupByNumber: "1" # 1~100, how many review message in 1 slack message.
        slackBotToken: "Slack App Bot User OAuth Token" # Slack Bot Token, send slack message through Slack Bot.
        slackBotTargetChannel: "Target Channel ID" # Slack Bot Token, send slack message through Slack Bot. (recommended, first priority)
        slackInCommingWebHookURL: "" # Slack In-Coming WebHook URL, Send slack message through In-Coming WebHook, not recommended, deprecated.
```

--------------------------------

### Ruby: Check Ruby path

Source: https://github.com/zhgchgli/zreviewtender/blob/main/README.md

Checks the current Ruby executable path to ensure it is not the system Ruby (/usr/bin/ruby). This is part of the setup for users not familiar with Ruby.

```bash
which ruby
```

--------------------------------

### Generate config YAML file

Source: https://github.com/zhgchgli/zreviewtender/blob/main/README.md

Run ZReviewTender -i to generate apple.yml and android.yml in the config/ folder.

```bash
ZReviewTender -i

```

--------------------------------

### Docker: Navigate to directory

Source: https://github.com/zhgchgli/zreviewtender/blob/main/README.md

Changes the current directory to the ZReviewTender project folder. Required before building the Docker image.

```bash
cd /ZReviewTender
```

--------------------------------

### Docker: Run container

Source: https://github.com/zhgchgli/zreviewtender/blob/main/README.md

Runs the Docker container, mounting the current directory to /usr/src/app. The container will execute ZReviewTender according to the configured schedule.

```bash
docker run -v ./:/usr/src/app zreviewtender
```

--------------------------------

### Check Apple App's Latest Reviews with custom config path

Source: https://github.com/zhgchgli/zreviewtender/blob/main/README.md

Run ZReviewTender --apple=PATH_TO_APPLE_CONFIG_YAML_FILE to specify the Apple config file.

```bash
ZReviewTender --apple=PATH_TO_APPLE_CONFIG_YAML_FILE

```

--------------------------------

### Docker: Clone repository

Source: https://github.com/zhgchgli/zreviewtender/blob/main/README.md

Clones the ZReviewTender repository from GitHub. Required before building the Docker image.

```bash
git clone https://github.com/ZhgChgLi/ZReviewTender
```

--------------------------------

### Docker: Build image

Source: https://github.com/zhgchgli/zreviewtender/blob/main/README.md

Builds the Docker image with the specified cron schedule and command. CRON_SETTING sets the crontab schedule, ZREVIEWTENDER_COMMAND sets the ZReviewTender command (refer to configuration block).

```bash
docker build -t zreviewtender:latest --build-arg CRON_SETTING="*/30 * * * *" --build-arg ZREVIEWTENDER_COMMAND="-r" .
```

--------------------------------

### Generate config files with ZReviewTender -i

Source: https://github.com/zhgchgli/zreviewtender/blob/main/README.md

Command to generate apple.yml and android.yml configuration files using the interactive mode.

```bash
ZReviewTender -i
```

--------------------------------

### Check both Apple & Android App's Latest Reviews with custom config path

Source: https://github.com/zhgchgli/zreviewtender/blob/main/README.md

Run ZReviewTender --run=CONFIG_FOLDER to specify the config YAML file path.

```bash
ZReviewTender --run=CONFIG_FOLDER

```

--------------------------------

### Upgrade ZReviewTender to Latest Release Version

Source: https://github.com/zhgchgli/zreviewtender/blob/main/README.md

Run ZReviewTender -n to upgrade to the latest release version (only RubyGem).

```bash
ZReviewTender -n

```

--------------------------------

### Configure FilterProcessor in apple.yml or android.yml

Source: https://github.com/zhgchgli/zreviewtender/blob/main/quickstart.md

Add this YAML block to the `processors` section of `/config/apple.yml` or `/config/android.yml` to enable filtering of reviews. The `enable` flag turns the filter on, and the `keywordsInclude`, `ratingsInclude`, and `territoriesInclude` arrays specify which reviews to forward.

```yaml
    - FilterProcessor:
        class: "FilterProcessor"
        enable: true # enable
        keywordsInclude: [] # keywords you want to filter out
        ratingsInclude: [] # ratings you want to filter out
        territoriesInclude: [] # territories you want to filter out (territory for Apple e.g. TWN)
```

--------------------------------

### Show Current ZReviewTender Version

Source: https://github.com/zhgchgli/zreviewtender/blob/main/README.md

Run ZReviewTender -v to display the current version.

```bash
ZReviewTender -v

```

--------------------------------

### Check Android App's Latest Reviews with custom config path

Source: https://github.com/zhgchgli/zreviewtender/blob/main/README.md

Run ZReviewTender --googleAndroid=PATH_TO_ANDROID_CONFIG_YAML_FILE to specify the Android config file.

```bash
ZReviewTender --googleAndroid=PATH_TO_ANDROID_CONFIG_YAML_FILE

```

--------------------------------

### Check Apple App's Latest Reviews

Source: https://github.com/zhgchgli/zreviewtender/blob/main/README.md

Run ZReviewTender -a to check Apple reviews using apple.yml in the config folder.

```bash
ZReviewTender -a

```

--------------------------------

### Check both Apple & Android App's Latest Reviews

Source: https://github.com/zhgchgli/zreviewtender/blob/main/README.md

Run ZReviewTender -r to check latest reviews using apple.yml and android.yml in the config folder.

```bash
ZReviewTender -r

```

--------------------------------

### GitHub Action workflow for ZReviewTender

Source: https://github.com/zhgchgli/zreviewtender/blob/main/README.md

Workflow that runs ZReviewTender on a schedule (every 6 hours) or manually. Uses the ZhgChgLi/ZReviewTender@main action with the -r command. Change the command to any other ZReviewTender command.

```yaml
name: ZReviewTender
on:
  workflow_dispatch:
  schedule:
    - cron: "15 */6 * * *" # Check for new reviews every 6 hours.

jobs:
  ZReviewTender:
    runs-on: ubuntu-latest
    steps:
    - name: ZReviewTender Automatic Bot
      uses: ZhgChgLi/ZReviewTender@main
      with:
        command: '-r'

```

--------------------------------

### Check Android App's Latest Reviews

Source: https://github.com/zhgchgli/zreviewtender/blob/main/README.md

Run ZReviewTender -g to check Android reviews using android.yml in the config folder.

```bash
ZReviewTender -g

```

--------------------------------

### ZReviewTender GitHub Actions workflow

Source: https://github.com/zhgchgli/zreviewtender/blob/main/quickstart.md

Default GitHub Actions workflow for ZReviewTender. It runs on a schedule (every 6 hours) and can be triggered manually. The `command` parameter is set to `-r` to check reviews for both Android and Apple (iOS).

```yaml
name: ZReviewTender
on:
  workflow_dispatch:
  schedule:
    - cron: "15 */6 * * *" #check new review every 6 hour.

jobs:
  ZReviewTender:
    runs-on: ubuntu-latest
    steps:
    - name: ZReviewTender Automatic Bot
      uses: ZhgChgLi/ZReviewTender@main
      with:
        command: '-r'
```

--------------------------------

### GoogleTranslateProcessor configuration for apple.yml

Source: https://github.com/zhgchgli/zreviewtender/blob/main/quickstart.md

Configuration block for the GoogleTranslateProcessor in apple.yml. Requires the Cloud Translation API enabled on the GCP project and the service account key file path. The territoriesExclude list uses Apple territory codes (e.g., TWN).

```yaml
    - GoogleTranslateProcessor: # Google Translate Processor, will translate review text to your language, you can remove whole block if you don't need it.
        class: "GoogleTranslateProcessor"
        enable: true # enable
        googleTranslateAPIKeyFilePath: './config/XXXX-XXXX.json' # Google Translate API Service Account Credential .json File Path
        googleTranslateTargetLang: 'zh-TW' # Translate to what Language
        googleTranslateTerritoriesExclude: ["TWN","CHN"] # Review origin Territory that you don't want to translate. (territory for Apple e.g. TWN)
```

--------------------------------

### Clean Last Check Timestamp Log

Source: https://github.com/zhgchgli/zreviewtender/blob/main/README.md

Run ZReviewTender -d to clean the last check timestamp log and return to initial state.

```bash
ZReviewTender -d

```

--------------------------------

### GoogleTranslateProcessor configuration for android.yml

Source: https://github.com/zhgchgli/zreviewtender/blob/main/quickstart.md

Configuration block for the GoogleTranslateProcessor in android.yml. Requires the Cloud Translation API enabled on the GCP project and the service account key file path. The territoriesExclude list uses Android language codes (e.g., zh-Hant, en).

```yaml
    - GoogleTranslateProcessor: # Google Translate Processor, will translate review text to your language, you can remove whole block if you don't need it.
        class: "GoogleTranslateProcessor"
        enable: true # enable
        googleTranslateAPIKeyFilePath: './config/XXXX-XXXX.json' # Google Translate API Service Account Credential .json File Path
        googleTranslateTargetLang: 'zh-TW' # Translate to what Language
        googleTranslateTerritoriesExclude: ["zh-Hant","zh-Hans"] # Review origin Territory (language) that you don't want to translate. (language for android e.g. zh-Hant, en)
```
Tokens:
Raw