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

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

Last synced: about 2 months ago
JSON representation

Github Action to upload an artifact to Emerge.

• Host: GitHub
• URL: https://github.com/emergetools/emerge-upload-action
• Owner: EmergeTools
• Created: 2021-09-22T21:03:33.000Z (over 3 years ago)
• Default Branch: main
• Last Pushed: 2024-04-01T22:06:57.000Z (9 months ago)
• Last Synced: 2024-11-04T14:52:23.326Z (about 2 months ago)
• Language: TypeScript
• Size: 488 KB
• Stars: 11
• Watchers: 3
• Forks: 6
• Open Issues: 1
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Emerge upload action - (iOS future support only)

> [!IMPORTANT]

> This action is no longer maintained for Android usage (please use the [Emerge Gradle plugin](https://docs.emergetools.com/docs/gradle-plugin) instead). As for iOS, if you don't have an existing CI setup or already use fastlane, we strongly recommend you use the [Emerge Fastlane plugin](https://docs.emergetools.com/docs/fastlane).

> If using the Fastlane/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

```

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).