Skip to content

Latest commit

 

History

History
94 lines (65 loc) · 3.34 KB

README.md

File metadata and controls

94 lines (65 loc) · 3.34 KB
Raw

Emerge CLI

The official CLI for Emerge Tools.

Emerge offers a suite of products to help optimize app size, performance, and quality by detecting regressions before they make it to production. This plugin provides a set of actions to interact with the Emerge API.

Installation

This tool is packaged as a Ruby Gem which can be installed by:

gem install emerge

API Key

Follow our guide to obtain an API key for your organization. The API Token is used by the CLI to authenticate with the Emerge API. The CLI will automatically pick up the API key if configured as an EMERGE_API_TOKEN environment variable, or you can manually pass it into individual commands.

Snapshots

Uploads a directory of images to be used in Emerge Snapshot Testing.

Run emerge upload snapshots -h for a full list of supported options.

Example:

emerge upload snapshots \
  --name "AwesomeApp" \
  --id "com.emerge.awesomeapp" \
  --repo-name "EmergeTools/AwesomeApp" \
  path/to/snapshot/images

Git Configuration

For CI diffs to work, Emerge needs the appropriate Git sha and base_sha values set on each build. Emerge will automatically compare a build at sha against the build we find matching the base_sha for a given application id. We also recommend setting pr_number, branch, and repo_name for the best experience.

For example:

  • sha: pr-branch-commit-1
  • base_sha: main-branch-commit-1
  • pr_number: 42
  • branch: my-awesome-feature
  • repo_name: EmergeTools/hackernews

Will compare the snapshot diffs of your pull request changes.

This plugin will automatically configure Git values for you assuming certain Github workflow triggers:

on:
  # Produce base builds with a 'sha' when commits are pushed to the main branch
  push:
    branches: [main]

  # Produce branch comparison builds with `sha` and `base_sha` when commits are pushed
  # to open pull requests
  pull_request:
    branches: [main]
  ...

If this doesn't cover your use-case, manually set the sha and base_sha values when calling the Emerge plugin.

Using with swift-snapshot-testing

Snapshots generated via swift-snapshot-testing are natively supported by the CLI by setting --client-library swift-snapshot-testing and a --project-root directory. This will scan your project for all images found in __Snapshot__ directories.

Example:

emerge upload snapshots \
  --name "AwesomeApp swift-snapshot-testing" \
  --id "com.emerge.awesomeapp.swift-snapshot-testing" \
  --repo-name "EmergeTools/AwesomeApp" \
  --client-library swift-snapshot-testing \
  --project-root /my/awesomeapp/ios/repo

Using with Paparazzi

Snapshots generated via Paparazzi are natively supported by the CLI by setting --client-library paparazzi and a --project-root directory. This will scan your project for all images found in src/test/snapshots/images directories.

Example:

emerge upload snapshots \
  --name "AwesomeApp Paparazzi" \
  --id "com.emerge.awesomeapp.paparazzi" \
  --repo-name "EmergeTools/AwesomeApp" \
  --client-library paparazzi \
  --project-root /my/awesomeapp/android/repo