https://github.com/iamdtang/ember-cli-doorkeeper

Fail CI on pull requests in Ember apps and addons if code coverage drops by a specified threshold
https://github.com/iamdtang/ember-cli-doorkeeper

ci coverage coverage-drops ember emberjs

Last synced: 7 days ago
JSON representation

Fail CI on pull requests in Ember apps and addons if code coverage drops by a specified threshold

• Host: GitHub
• URL: https://github.com/iamdtang/ember-cli-doorkeeper
• Owner: iamdtang
• License: mit
• Created: 2017-11-10T02:51:48.000Z (about 7 years ago)
• Default Branch: master
• Last Pushed: 2018-03-20T07:28:22.000Z (almost 7 years ago)
• Last Synced: 2024-12-11T18:57:42.527Z (12 days ago)
• Topics: ci, coverage, coverage-drops, ember, emberjs
• Language: JavaScript
• Homepage: https://www.npmjs.com/package/ember-cli-doorkeeper
• Size: 39.1 KB
• Stars: 3
• Watchers: 2
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.md

Awesome Lists containing this project

README

        
[![Build Status](https://travis-ci.org/skaterdav85/ember-cli-doorkeeper.svg?branch=master)](https://travis-ci.org/skaterdav85/ember-cli-doorkeeper)

# ember-cli-doorkeeper

This addon will fail CI on pull requests in Ember apps and addons if code coverage drops by a specified threshold when using [`ember-cli-code-coverage`](https://github.com/kategengler/ember-cli-code-coverage).

## Installation and Configuration

1. `ember install ember-cli-doorkeeper`

2. Set your `npm test` command to `ember doorkeeper`

3. Add your test command to `testCommand` in `.doorkeeperrc.js`. The default is `COVERAGE=true ember test`. For addons, use `COVERAGE=true ember try:each`.

4. Add `!/coverage/coverage-summary.json` to `.gitignore`

5. Run your test suite locally to generate `coverage/coverage-summary.json` and commit it to your repo.

## How It Works

The [`ember-cli-code-coverage`](https://github.com/kategengler/ember-cli-code-coverage) addon generates code coverage results in `coverage/coverage-summary.json`. This addon works by generating code coverage for a PR and comparing the results against the code coverage results on the `master` branch (you can configure which branch to compare against in `.doorkeeperrc.js` via the `mainBranch` option).

When adding this to your project for the first time, `coverage/coverage-summary.json` may not be under version control. If this file isn't present in `mainBranch`, your tests will run as normal and code coverage comparison won't run.

In order to keep `coverage/coverage-summary.json` up to date in `mainBranch`, each PR should contain a new `coverage/coverage-summary.json`. CI will still generate a new one on PRs and use that to compare against the one in `mainBranch`, but it won't commit it back to the PR. __If someone knows how to do this with various CI systems, please reach out and we can update this README with examples.__