Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/MatteoH2O1999/github-actions-jest-reporter
A reporter allowing for fast and easy navigation through the logs produced by Jest in the Github Actions UI
https://github.com/MatteoH2O1999/github-actions-jest-reporter
actions github-actions jest jest-reporter testing
Last synced: 3 months ago
JSON representation
A reporter allowing for fast and easy navigation through the logs produced by Jest in the Github Actions UI
- Host: GitHub
- URL: https://github.com/MatteoH2O1999/github-actions-jest-reporter
- Owner: MatteoH2O1999
- License: mit
- Created: 2022-11-03T22:09:41.000Z (about 2 years ago)
- Default Branch: master
- Last Pushed: 2024-04-16T23:58:18.000Z (7 months ago)
- Last Synced: 2024-04-18T06:59:53.850Z (7 months ago)
- Topics: actions, github-actions, jest, jest-reporter, testing
- Language: TypeScript
- Homepage:
- Size: 29 MB
- Stars: 11
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-jest - github-actions-jest-reporter
README
# Github Actions Jest reporter
[](https://github.com/MatteoH2O1999/github-actions-jest-reporter/actions/workflows/test.yml)
[](https://www.npmjs.com/package/@matteoh2o1999/github-actions-jest-reporter)
A fast and easy way of navigating through the logs produced by Jest in the Github Actions UI.
## Motivation
Jest's default reporter omits all of the datails of the passed and outputs a continuous log of the failed ones.
While this is useful in a local development environment, it becomes cumbersome to read as a github action log.
The aim of this reporter is to log all the results (including passed tests), but folding them neatly as groups leveraging Github Actions builtin group function.
Logs of failures are grouped and folded by test file so they can be opened and read in a more organized way.
## Dependencies
The package depends on `jest` (obviously), `chalk` and the `@actions/core` package.
## Installation
The reporter can be installed directly from npm:
```bash
npm install --save-dev @matteoh2o1999/github-actions-jest-reporter
```
## Usage
There are two ways to use the reporter in your Jest testing.
### Create CI test script (recommended)
In your `package.json` just add a line in your script section:
```diff
{
...
"scripts": {
...
"test": "jest",
+ "test-ci": "jest --reporters='@matteoh2o1999/github-actions-jest-reporter'"
}
}
```
Then in your `test.yml` use the new script instead of the old one:
```diff
steps:
- name: Checkout code
...
- name: Run tests
- run: npm run test
+ run: npm run test-ci
```
### Add as reporter in `jest.config`
Add the reporter to the `reporters` array in your configuration file:
```diff
module.exports: {
...
- reporters: [...],
+ reporters: [..., '@matteoh2o1999/github-actions-jest-reporter'],
}
```
> :warning: **Warning:** adding this reporter in your `jest.config` file will also impact local testing.
## Troubleshooting
### My logs are not colored
This is a known problem related to `chalk` not recognizing Github Actions terminal as capable of writing colors.
Until this is fixed on their end a workaround is to force color output with an environment variable:
```diff
steps:
- name: Checkout code
...
- name: Run tests
run: npm run test-ci
+ env:
+ FORCE_COLOR: 1
```