https://github.com/vbfox/jest-buildkite-reporter

A jest reporter to have test results in BuildKite as annotations
https://github.com/vbfox/jest-buildkite-reporter

build buildkite ci javascript jest

Last synced: about 2 months ago
JSON representation

A jest reporter to have test results in BuildKite as annotations

• Host: GitHub
• URL: https://github.com/vbfox/jest-buildkite-reporter
• Owner: vbfox
• License: mit
• Created: 2019-11-20T09:55:16.000Z (about 5 years ago)
• Default Branch: master
• Last Pushed: 2023-07-18T20:14:53.000Z (over 1 year ago)
• Last Synced: 2024-11-20T13:22:42.790Z (3 months ago)
• Topics: build, buildkite, ci, javascript, jest
• Language: TypeScript
• Size: 923 KB
• Stars: 5
• Watchers: 2
• Forks: 2
• Open Issues: 12
• Metadata Files:
  • Readme: readme.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Jest Buildkite reporter

[![CI](https://github.com/vbfox/jest-buildkite-reporter/workflows/CI/badge.svg)](https://github.com/vbfox/jest-buildkite-reporter/actions?query=workflow%3ACI)

[![npm](https://img.shields.io/npm/v/jest-buildkite-reporter)](https://www.npmjs.com/package/jest-buildkite-reporter)

Report Jest test results in [Buildkite](https://buildkite.com/) output as annotations

## Usage

Install the package :

```bash

npm install -D jest-buildkite-reporter

# or

yarn add -D jest-buildkite-reporter

```

Add it your jest reporters. If you don't have any reporters

you should also add the `default` one or you will lose

the console output.

```javascript

module.exports = {

    reporters: ['default', 'jest-buildkite-reporter'],

};

```

The reporter only run when it detect that buildkite is present,

so there is no need to conditionally include it.

### Inside docker

When your tests are running in a docker containter they won't have access to buildkite by default and some environment variables need to be passed to them.

When `jest` is called as a `RUN` step inside the `Dockerfile` it need to specify the following args:

```dockerfile

ARG BUILDKITE

ARG BUILDKITE_AGENT_ACCESS_TOKEN

ARG BUILDKITE_JOB_ID

RUN yarn run jest

```

And they need to be passed to the `docker build` command:

```bash

docker build --build-arg BUILDKITE --build-arg BUILDKITE_AGENT_ACCESS_TOKEN --build-arg BUILDKITE_JOB_ID .

```

## License

This project is using the [MIT](LICENSE) license.

## Similar projects

* [junit-annotate-buildkite-plugin](https://github.com/buildkite-plugins/junit-annotate-buildkite-plugin) Official Buildkite plugin for JUnit

* [jest-teamcity-reporter](https://github.com/winterbe/jest-teamcity-reporter) Jest reporter for TeamCity

* [jest-teamcity](https://github.com/itereshchenkov/jest-teamcity) Another Jest reporter for TeamCity

* [bugcrowd-test-summary-buildkite-plugin](https://github.com/bugcrowd/test-summary-buildkite-plugin) BugCrowd reporter for BuildKite