{"id":34856452,"url":"https://github.com/gaffer-sh/gaffer-uploader","last_synced_at":"2026-04-23T02:00:54.841Z","repository":{"id":264945840,"uuid":"791271046","full_name":"gaffer-sh/gaffer-uploader","owner":"gaffer-sh","description":"Gaffer.sh Javascript Action","archived":false,"fork":false,"pushed_at":"2025-12-25T18:03:12.000Z","size":5609,"stargazers_count":2,"open_issues_count":6,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-12-28T18:51:22.914Z","etag":null,"topics":["test-reporting","testing","testing-tools"],"latest_commit_sha":null,"homepage":"https://gaffer.sh","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/gaffer-sh.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":"CODEOWNERS","security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2024-04-24T12:15:13.000Z","updated_at":"2025-12-25T18:03:15.000Z","dependencies_parsed_at":"2024-11-26T23:36:18.966Z","dependency_job_id":null,"html_url":"https://github.com/gaffer-sh/gaffer-uploader","commit_stats":null,"previous_names":["gaffer-sh/gaffer-uploader"],"tags_count":7,"template":false,"template_full_name":"actions/javascript-action","purl":"pkg:github/gaffer-sh/gaffer-uploader","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/gaffer-sh%2Fgaffer-uploader","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/gaffer-sh%2Fgaffer-uploader/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/gaffer-sh%2Fgaffer-uploader/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/gaffer-sh%2Fgaffer-uploader/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/gaffer-sh","download_url":"https://codeload.github.com/gaffer-sh/gaffer-uploader/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/gaffer-sh%2Fgaffer-uploader/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":32162611,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-04-22T17:06:48.269Z","status":"online","status_checked_at":"2026-04-23T02:00:06.710Z","response_time":53,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"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":["test-reporting","testing","testing-tools"],"created_at":"2025-12-25T20:01:39.847Z","updated_at":"2026-04-23T02:00:54.822Z","avatar_url":"https://github.com/gaffer-sh.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Gaffer Uploader GitHub Action\n\n[![GitHub Super-Linter](https://github.com/actions/typescript-action/actions/workflows/linter.yml/badge.svg)](https://github.com/super-linter/super-linter)\n![CI](https://github.com/actions/typescript-action/actions/workflows/ci.yml/badge.svg)\n[![Check dist/](https://github.com/actions/typescript-action/actions/workflows/check-dist.yml/badge.svg)](https://github.com/actions/typescript-action/actions/workflows/check-dist.yml)\n[![Coverage](./badges/coverage.svg)](./badges/coverage.svg)\n\nUse this action to upload your test reports to Gaffer.\n\nFor more examples, visit the\n[Gaffer GitHub Action documentation](https://docs.gaffer.sh/guides/github-action).\n\n## Inputs\n\n| Input            | Required | Description                                                |\n| ---------------- | -------- | ---------------------------------------------------------- |\n| `gaffer_api_key` | Yes      | Gaffer API key for your project                            |\n| `report_path`    | Yes      | Path to the report file or directory to upload             |\n| `api_endpoint`   | No       | Custom API endpoint URL (for preview/staging environments) |\n| `commit_sha`     | No       | Git commit SHA to associate with the test run              |\n| `branch`         | No       | Git branch to associate with the test run                  |\n| `test_framework` | No       | Test framework used (e.g., jest, vitest, pytest)           |\n| `test_suite`     | No       | Name of the test suite                                     |\n\n## Usage\n\n### Basic Usage\n\n```yaml\n- name: Gaffer Upload\n  uses: gaffer-sh/gaffer-uploader@v1\n  if: always()\n  with:\n    gaffer_api_key: ${{ secrets.GAFFER_API_KEY }}\n    report_path: ./test-results.html\n    commit_sha: ${{ github.sha }}\n    branch: ${{ github.ref_name }}\n    test_framework: jest\n    test_suite: unit\n```\n\n### Usage with Artifacts\n\n```yaml\n- name: Download all reports from artifacts\n  uses: actions/download-artifact@v4\n  with:\n    path: all-reports\n    pattern: all-reports-*\n    merge-multiple: true\n\n- name: Gaffer Upload\n  uses: gaffer-sh/gaffer-uploader@v0.3.0\n  if: always()\n  with:\n    gaffer_api_key: ${{ secrets.GAFFER_API_KEY }}\n    report_path: ./all-reports\n    commit_sha: ${{ github.sha }}\n    branch: ${{ github.ref_name }}\n    test_framework: jest\n    test_suite: unit\n```\n\n### Custom API Endpoint\n\nFor preview or staging environments, use the `api_endpoint` input:\n\n```yaml\n- name: Gaffer Upload\n  uses: gaffer-sh/gaffer-uploader@v0.3.0\n  if: always()\n  with:\n    gaffer_api_key: ${{ secrets.GAFFER_API_KEY }}\n    report_path: ./test-results.html\n    api_endpoint: https://preview.gaffer.sh/api/upload\n    commit_sha: ${{ github.sha }}\n    branch: ${{ github.ref_name }}\n```\n\n## Usage with Environment Variables\n\nDepending on your GitHub Action trigger, you may need to use different methods\nto set the `branch` parameter.\n\nThis is the most reliable way to set the `branch` parameter:\n\n```yaml\nenv:\n  branch_name: ${{ github.head_ref || github.ref_name }}\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgaffer-sh%2Fgaffer-uploader","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fgaffer-sh%2Fgaffer-uploader","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgaffer-sh%2Fgaffer-uploader/lists"}