Skip to content

A jest reporter to have test results in BuildKite as annotations

License

Notifications You must be signed in to change notification settings

vbfox/jest-buildkite-reporter

Repository files navigation

Jest Buildkite reporter

CI npm

Report Jest test results in Buildkite output as annotations

Usage

Install the package :

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.

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:

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:

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

License

This project is using the MIT license.

Similar projects

About

A jest reporter to have test results in BuildKite as annotations

Topics

Resources

License

Stars

Watchers

Forks

Packages

No packages published