{"id":20149035,"url":"https://github.com/emergetools/emerge-upload-action","last_synced_at":"2025-08-21T12:11:32.630Z","repository":{"id":39020341,"uuid":"409355734","full_name":"EmergeTools/emerge-upload-action","owner":"EmergeTools","description":"Github Action to upload an artifact to Emerge.","archived":false,"fork":false,"pushed_at":"2025-03-09T02:01:25.000Z","size":541,"stargazers_count":11,"open_issues_count":1,"forks_count":6,"subscribers_count":3,"default_branch":"main","last_synced_at":"2025-04-09T20:01:48.245Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/EmergeTools.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2021-09-22T21:03:33.000Z","updated_at":"2025-03-09T02:01:28.000Z","dependencies_parsed_at":"2024-06-21T16:44:03.625Z","dependency_job_id":"b07fa2a3-9d02-47cc-bf0d-2b35c1d822f5","html_url":"https://github.com/EmergeTools/emerge-upload-action","commit_stats":{"total_commits":11,"total_committers":3,"mean_commits":"3.6666666666666665","dds":"0.36363636363636365","last_synced_commit":"6703bedaa4ed7286e262b06f28bf63b974744e04"},"previous_names":[],"tags_count":8,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/EmergeTools%2Femerge-upload-action","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/EmergeTools%2Femerge-upload-action/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/EmergeTools%2Femerge-upload-action/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/EmergeTools%2Femerge-upload-action/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/EmergeTools","download_url":"https://codeload.github.com/EmergeTools/emerge-upload-action/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248103865,"owners_count":21048245,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-11-13T22:40:54.934Z","updated_at":"2025-04-09T20:02:19.836Z","avatar_url":"https://github.com/EmergeTools.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Emerge upload action\n\n\u003e [!WARNING]\n\u003e This action is **deprecated** and no longer maintained.\\\n\u003e For Android, use the [Emerge Gradle plugin](https://docs.emergetools.com/docs/gradle-plugin) instead.\\\n\u003e 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.\\\n\u003e Note: when using the Fastlane or Gradle plugins, the GitHub action is unnecessary, as all upload functionality is built into the respective integrations.\n\nAction to upload your build directly to Emerge for analysis.\n\n## Usage\n\nThe Emerge upload action should be run on any event that should trigger a size analysis. Examples of this are:\n\n- When pushing to specific branches (main/release).\n- On any PR to the main branch.\n\nSee [action.yml](https://github.com/EmergeTools/emerge-upload-action/blob/main/action.yml) for all inputs and\ndescriptions.\n\n### Create Emerge API key and add to secrets\n\nFirst, create an Emerge API key. You can create one from your [Emerge profile page](https://www.emergetools.com/profile).\n\n![Create Emerge API Key](./docs/api_key.png)\n\nAdd the API key to your secrets in your repository. **Do not leave this key in plain text in your workflow!**\n\n[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)\n\n### Incorporate in your workflow\n\nBuild your artifact in a step before the Emerge upload action. Pass the generated artifact's path as the `artifact_path`\nargument, and your Emerge API key secret as the `emerge_api_key` argument:\n\n```yaml\nname: Your workflow\n\non:\n  push:\n    branches: [main]\n  pull_request:\n    branches: [main]\n\njobs:\n  build:\n    runs-on: ubuntu-latest\n    steps:\n      - uses: actions/checkout@v2\n      - name: Generate iOS archive build\n        run: # generate release build, e.g. with xcodebuild\n      - name: Upload artifact to Emerge\n        uses: EmergeTools/emerge-upload-action@v1.0.4\n        with:\n          artifact_path: path/to/app-release.xcarchive.zip\n          emerge_api_key: ${{ secrets.EMERGE_API_KEY }}\n          build_type: release # Optional, change if your workflow builds a specific type\n          app_id_suffix: snapshots # Optional, change if needed, see https://docs.emergetools.com/docs/integrate-into-ci#which-builds-should-be-uploaded\n```\n\nAfter uploading, Emerge will run analysis on the uploaded build. If you haven't, set up Github comments by following\nour [Github documentation](https://docs.emergetools.com/docs/github).\n\nFor more details about the upload process and Emerge's supported artifact types, see\nthe [Emerge Uploading docs](https://docs.emergetools.com/docs/uploading-basics).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Femergetools%2Femerge-upload-action","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Femergetools%2Femerge-upload-action","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Femergetools%2Femerge-upload-action/lists"}