{"id":15090062,"url":"https://github.com/yakkadev/jest-summary-reader","last_synced_at":"2026-02-09T07:08:40.455Z","repository":{"id":253564018,"uuid":"843792529","full_name":"YakkaDev/jest-summary-reader","owner":"YakkaDev","description":"Jest summary reader Github Action.","archived":false,"fork":false,"pushed_at":"2024-08-17T18:38:29.000Z","size":302,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-05-31T01:21:02.422Z","etag":null,"topics":["actions","github","jest","reader","summary"],"latest_commit_sha":null,"homepage":"https://github.com/marketplace/actions/jest-summary-reader","language":"JavaScript","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/YakkaDev.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":".github/FUNDING.yml","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},"funding":{"buy_me_a_coffee":"yakkadev"}},"created_at":"2024-08-17T12:39:59.000Z","updated_at":"2024-08-17T18:41:57.000Z","dependencies_parsed_at":"2024-08-18T16:16:18.737Z","dependency_job_id":null,"html_url":"https://github.com/YakkaDev/jest-summary-reader","commit_stats":null,"previous_names":["yakkadev/jest-summary-reader"],"tags_count":1,"template":false,"template_full_name":null,"purl":"pkg:github/YakkaDev/jest-summary-reader","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/YakkaDev%2Fjest-summary-reader","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/YakkaDev%2Fjest-summary-reader/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/YakkaDev%2Fjest-summary-reader/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/YakkaDev%2Fjest-summary-reader/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/YakkaDev","download_url":"https://codeload.github.com/YakkaDev/jest-summary-reader/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/YakkaDev%2Fjest-summary-reader/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":271085461,"owners_count":24696693,"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","status":"online","status_checked_at":"2025-08-18T02:00:08.743Z","response_time":89,"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":["actions","github","jest","reader","summary"],"created_at":"2024-09-25T09:04:23.880Z","updated_at":"2026-02-09T07:08:40.450Z","avatar_url":"https://github.com/YakkaDev.png","language":"JavaScript","funding_links":["https://buymeacoffee.com/yakkadev"],"categories":[],"sub_categories":[],"readme":"# Jest-Summary-Reader Github Action\n![Jest Coverage](https://img.shields.io/endpoint?url=https://gist.githubusercontent.com/YakkaDev/25a7339dde450b2a63576f0ec7575448/raw/jest-coverage.json)\n![Latest Release](https://img.shields.io/endpoint?url=https://gist.githubusercontent.com/YakkaDev/25a7339dde450b2a63576f0ec7575448/raw/git-latest-release.json) \n![Package Size](https://img.shields.io/endpoint?url=https://gist.githubusercontent.com/YakkaDev/25a7339dde450b2a63576f0ec7575448/raw/git-size.json) \n![Files Count](https://img.shields.io/endpoint?url=https://gist.githubusercontent.com/YakkaDev/25a7339dde450b2a63576f0ec7575448/raw/git-file-count.json) \n![Last Commit](https://img.shields.io/endpoint?url=https://gist.githubusercontent.com/YakkaDev/25a7339dde450b2a63576f0ec7575448/raw/git-last-commit-date.json)\n\n- [Introduction](#introduction)\n- [Usage](#usage)\n- [Options](#options)\n- [Outputs](#outputs)\n- [Authors](#authors)\n- [License](#license)\n- [Acknowledgments](#acknowledgments)\n\n## Introduction\nThis [GitHub Action](https://github.com/features/actions) resolves a [Jest](https://jestjs.io/) *coverage-summary file* into simple percentage values.\n\n[Jest-Summary-Reader](https://github.com/YakkaDev/jest-coverage-reader) based on the CommonJS engine and is limited by Github Actions.\n\n## Usage\nAt first, you need to edit your jest settings file and add the following lines:\n```js\ncoverageReporters: [\n  \"json-summary\"\n]\n```\n\nThen, you need to generate the `coverage-summary.json` file in one of the possible ways, for example, using the command line argument:\n```js\njest --coverage\n```\n\nFinally, you need to specify the path to this file relative to the root directory of the project in your GitHub Actions, following the example:\n```yml\n  steps:\n    - name: Checkout repository\n      uses: actions/checkout@v4\n\n    - name: Read Jest-Summary\n      id: jest-summary\n      uses: YakkaDev/jest-summary-reader@v1.0.0\n      with:\n        path: ./coverage/coverage-summary.json\n          \n    - run: |\n        echo Coverage Average - ${{ steps.jest-summary.outputs.average }}\n        echo Coverage Functions - ${{ steps.jest-summary.outputs.functions }}\n        echo Coverage Lines - ${{ steps.jest-summary.outputs.lines }}\n        echo Coverage Statements - ${{ steps.jest-summary.outputs.statements }}\n        echo Coverage Branches - ${{ steps.jest-summary.outputs.branches }}\n```\n\nDetailed information on setting up Jest can be found directly on the [Jest documentation page](https://jestjs.io/docs/configuration).\n\n## Options\nBelow you will find all possible options of this application, as well as their description and default values.\n\n| Option         | Description                               | Requried | Default            |\n|:--------------:|-------------------------------------------|:--------:|--------------------|\n| path           | Path to coverage-summary file             | Yes      | -                  |\n| format         | Extension of coverage-summary file        | No       | json               |\n\n## Outputs\n| Output     | Description                                       |\n|:----------:|---------------------------------------------------|\n| average    | Average percentage among all categories           |\n| functions  | The percentage value among all covered functions  |\n| lines      | The percentage value among all covered rows       |\n| statements | The percentage value among all covered statements |\n| branches   | The percentage value among all covered branches   |\n\n## Authors\nThe following people participated in the development:\n- [Illia «YakkaDev» Korovin](https://github.com/YakkaDev)\n\n## License\nThis project is released under the [MIT License](https://github.com/YakkaDev/jest-coverage-reader/LICENSE).\n\n## Acknowledgments\nThe application uses a [@actions/core](https://github.com/actions/toolkit) packages.\n\n---\n\n\u003c!-- Security scan triggered at 2025-09-02 03:19:01 --\u003e","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fyakkadev%2Fjest-summary-reader","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fyakkadev%2Fjest-summary-reader","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fyakkadev%2Fjest-summary-reader/lists"}