https://github.com/emergetools/emerge-upload-action

Github Action to upload an artifact to Emerge.
https://github.com/emergetools/emerge-upload-action

Last synced: 3 months ago
JSON representation

Github Action to upload an artifact to Emerge.

• Host: GitHub
• URL: https://github.com/emergetools/emerge-upload-action
• Owner: EmergeTools
• License: mit
• Created: 2021-09-22T21:03:33.000Z (almost 4 years ago)
• Default Branch: main
• Last Pushed: 2025-03-09T02:01:25.000Z (4 months ago)
• Last Synced: 2025-04-09T20:01:48.245Z (3 months ago)
• Language: TypeScript
• Size: 528 KB
• Stars: 11
• Watchers: 3
• Forks: 6
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Emerge upload action

> [!WARNING]

> This action is **deprecated** and no longer maintained.\

> For Android, use the [Emerge Gradle plugin](https://docs.emergetools.com/docs/gradle-plugin) instead.\

> For iOS, we strongly recommend you use the [Emerge Fastlane plugin](https://docs.emergetools.com/docs/fastlane) if you don't have an existing CI setup or already use fastlane.\

> Note: when using the Fastlane or Gradle plugins, the GitHub action is unnecessary, as all upload functionality is built into the respective integrations.

Action to upload your build directly to Emerge for analysis.

## Usage

The Emerge upload action should be run on any event that should trigger a size analysis. Examples of this are:

- When pushing to specific branches (main/release).

- On any PR to the main branch.

See [action.yml](https://github.com/EmergeTools/emerge-upload-action/blob/main/action.yml) for all inputs and

descriptions.

### Create Emerge API key and add to secrets

First, create an Emerge API key. You can create one from your [Emerge profile page](https://www.emergetools.com/profile).

![Create Emerge API Key](./docs/api_key.png)

Add the API key to your secrets in your repository. **Do not leave this key in plain text in your workflow!**

[Learn more about creating and using encrypted secrets](https://help.github.com/en/actions/automating-your-workflow-with-github-actions/creating-and-using-encrypted-secrets)

### Incorporate in your workflow

Build your artifact in a step before the Emerge upload action. Pass the generated artifact's path as the `artifact_path`

argument, and your Emerge API key secret as the `emerge_api_key` argument:

```yaml

name: Your workflow

on:

  push:

    branches: [main]

  pull_request:

    branches: [main]

jobs:

  build:

    runs-on: ubuntu-latest

    steps:

      - uses: actions/checkout@v2

      - name: Generate iOS archive build

        run: # generate release build, e.g. with xcodebuild

      - name: Upload artifact to Emerge

        uses: EmergeTools/[email protected]

        with:

          artifact_path: path/to/app-release.xcarchive.zip

          emerge_api_key: ${{ secrets.EMERGE_API_KEY }}

          build_type: release # Optional, change if your workflow builds a specific type

          app_id_suffix: snapshots # Optional, change if needed, see https://docs.emergetools.com/docs/integrate-into-ci#which-builds-should-be-uploaded

```

After uploading, Emerge will run analysis on the uploaded build. If you haven't, set up Github comments by following

our [Github documentation](https://docs.emergetools.com/docs/github).

For more details about the upload process and Emerge's supported artifact types, see

the [Emerge Uploading docs](https://docs.emergetools.com/docs/uploading-basics).