https://github.com/semantic-release/cracks
:anger::mag: breaking change detection
https://github.com/semantic-release/cracks
Last synced: 3 months ago
JSON representation
:anger::mag: breaking change detection
- Host: GitHub
- URL: https://github.com/semantic-release/cracks
- Owner: semantic-release
- Created: 2015-05-11T15:03:32.000Z (over 10 years ago)
- Default Branch: master
- Last Pushed: 2024-01-02T08:20:08.000Z (about 2 years ago)
- Last Synced: 2024-04-13T16:33:23.102Z (almost 2 years ago)
- Language: JavaScript
- Homepage: https://www.npmjs.com/package/cracks
- Size: 17.6 KB
- Stars: 113
- Watchers: 8
- Forks: 9
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# cracks
[](https://travis-ci.org/semantic-release/cracks)
> This module can automatically detect breaking changes by running the
test suite of your last-release against the current codebase. That shouldn't fail.
_Note:_ This is under the assumption you're testing the API of your module rather than implementation details. Of course this is hard sometimes and you might get false positives. Better safe than sorry :)
## Install
```bash
npm install --save-dev cracks
```
## Configuration
**paths**: An array of paths (files/directories) that will be checked out from the last release to restore your test suite. Note that you should add "package.json", because it will install old "devDependencies" as well. Default: `["tests", "package.json"]`
**silent**: Whether to output the results of `npm test`. It will always output the results when a breaking change was detected. Default: `true`
The test command is currently hard coded as `npm test`, but will be configurable in the future.
## Usage
### As a [`semantic-release`](https://github.com/semantic-release/semantic-release) plugin
Add a "verifyRelease" plugin to the "release" field in your "package.json".
```json
"release": {
"verifyRelease": "cracks"
}
```
Passing options:
```json
"release": {
"verifyRelease": {
"path": "cracks",
"paths": ["tests", "package.json"],
"silent": true
}
}
```
### CLI
```
Usage:
cracks
Options:
-p, --paths Overwrite checkout paths
-s, --silent Suppress 'npm test' output
-v, --version Output the current version
-h, --help Output this help info
```
## Licence
The [MIT License (MIT)](http://opensource.org/licenses/MIT)
Copyright © 2015 [Christoph Witzko](https://twitter.com/christophwitzko)