{"id":13531662,"url":"https://github.com/IgnusG/jest-report-action","last_synced_at":"2025-04-01T19:32:32.635Z","repository":{"id":36977740,"uuid":"253326693","full_name":"IgnusG/jest-report-action","owner":"IgnusG","description":"Jest Reporter Action made easy - ish","archived":false,"fork":false,"pushed_at":"2023-12-04T11:53:43.000Z","size":2511,"stargazers_count":16,"open_issues_count":30,"forks_count":5,"subscribers_count":0,"default_branch":"master","last_synced_at":"2025-03-20T15:12:12.914Z","etag":null,"topics":["github-action","jest","junit"],"latest_commit_sha":null,"homepage":null,"language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"unlicense","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/IgnusG.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}},"created_at":"2020-04-05T20:33:08.000Z","updated_at":"2024-07-31T19:57:13.000Z","dependencies_parsed_at":"2024-01-11T00:02:34.160Z","dependency_job_id":"2e188fa6-3b5d-4c63-be55-abf8e6b4e804","html_url":"https://github.com/IgnusG/jest-report-action","commit_stats":{"total_commits":121,"total_committers":4,"mean_commits":30.25,"dds":0.05785123966942152,"last_synced_commit":"c006b890ba3c3b650e6c55916a643ca82b64133b"},"previous_names":[],"tags_count":32,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/IgnusG%2Fjest-report-action","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/IgnusG%2Fjest-report-action/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/IgnusG%2Fjest-report-action/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/IgnusG%2Fjest-report-action/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/IgnusG","download_url":"https://codeload.github.com/IgnusG/jest-report-action/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":246700729,"owners_count":20819926,"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":["github-action","jest","junit"],"created_at":"2024-08-01T07:01:04.691Z","updated_at":"2025-04-01T19:32:31.545Z","avatar_url":"https://github.com/IgnusG.png","language":"JavaScript","funding_links":[],"categories":["Community Resources"],"sub_categories":["Static Analysis"],"readme":"# Jest Github Actions Reporter\n\nCreates annotations based on the output of `jest-junit` (see [how to configure `jest-junit` properly](./README.md#jest-junit-configuration)) in your test files.\n\n## Example\n\n\u003ckbd\u003e.github/workflows/your-workflow.yml\u003c/kbd\u003e\n```\n    - uses: IgnusG/jest-report-action@v{ current version }\n      if: always() # Or use \"continue-on-error: true\" in previous test step\n      with:\n        access-token: ${{ secrets.GITHUB_TOKEN }}\n``` \n\n\u003cimg src=\"./docs/example-main.png\" alt=\"Example of Jest Annotations\" /\u003e\n\n## Inputs\n\n### `access-token` - **required**\n\nWe'll need that to enrich the actions run with annotations. The secret is automatically generated by github.com.\n\n### `junit-file` - *optional*\n\nThe location and/or the name of the JUnit file. `jest-junit` uses \u003ckbd\u003ejunit.xml\u003c/kbd\u003e as a default, which is the default here too. If you haven't changed it, you can omit this input.\n\n### `run-name` - *optional*\n\nThe name of your run. This is typically `build` but can be configured individually. Make sure it matches your workflow config:\n\n\u003ckbd\u003e.github/workflows/your-workflow.yml\u003c/kbd\u003e\n```yaml\nbuild: # \u003c- this one!\n    steps:\n        ...\n```\n\n### `check-name` - *optional*\n\nA custom name that will appear in the PR's check window. Useful if you have multiple test suites - code, pipelines, publishing process etc., each run with separate jest commands.  \nBe sure to run this action after each jest run, that way you can use the same name for the JUnit file - or omit it. \n\nOtherwise you have to give each generated JUnit file a unique name and pass it to `jest-report-action`.\n\n### `working-directory` - *optional*\n\nThe working directory, where the `junit-file`, as well as the sources (of test files) can be found. The default is the root directory of your project.\n\n## `jest-junit` Configuration\n\nHave a look at how to call `jest-junit` in your workflows in the [documentation](https://www.npmjs.com/package/jest-junit#usage).\nA very simple example is calling jest with a custom `--reporters` parameter:\n\n\u003ckbd\u003epackage.json\u003c/kbd\u003e and other\n```\n  jest --ci --reporters=default --reporters=jest-junit\n```\n\nTo provide **correct annotation locations**, you need to configure `jest-junit` to format the xml file in a compatible way.\n\nSet these in either your package.json or through enviornment variables while running jest in your CI (Github).\n\n\u003ckbd\u003epackage.json\u003c/kbd\u003e\n```json\n\"jest-junit\": {\n  \"suiteNameTemplate\": \"{filepath}\",\n  \"classNameTemplate\": \"{classname}\",\n  \"titleTemplate\": \"{title}\"\n}\n```\n\nRefer to [`jest-junit` Documentation](https://www.npmjs.com/package/jest-junit#configuration) to see other ways to configure these.\n\nThank you and have an **amazing day**!\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FIgnusG%2Fjest-report-action","html_url":"https://awesome.ecosyste.ms/projects/github.com%2FIgnusG%2Fjest-report-action","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FIgnusG%2Fjest-report-action/lists"}