Skip to content
semantic-release plugin checking if the new semantic release is breaking dependent projects
JavaScript
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
src
.gitignore
.npmrc
.travis.yml
README.md
package.json

README.md

dont-crack

semantic-release plugin checking if the new semantic release is breaking dependent projects

NPM

Build status semantic-release js-standard-style

This is semantic-release plugin for the verifyRelease step.

It ensures that a minor or a patch update to your module does NOT break modules that depend on it. A major version upgrade is allowed to break the dependent projects.

Uses dont-break internally.

Configuration

Install NPM plugin npm i -D dont-crack (assuming you have semantic-release already installed).

Add the "release" configuration block to your "package.json" and list all the projects (as github repos for now) which depend on your module and that you don't want to break accidentally. For example, if you want to test the new release against repos "bahmutov/foo" and "bahmutov/bar".

{
  "release": {
    "verifyRelease": {
      "path": "dont-crack",
      "test-against": [
        "https://github.com/bahmutov/foo",
        "https://github.com/bahmutov/bar"
      ]
    }
  }
}

That's it. If there is a new "minor" or "patch" semantic version determined from the commit log, it will be tested against these two repos. If their tests pass with the new dependency, the semantic release process will continue. If not, it will be aborted.

Debug

If something goes wrong, you can see the messages from this plugin by running with DEBUG=dont-crack ... environment variable.

Small print

Author: Gleb Bahmutov <gleb.bahmutov@gmail.com> © 2016

License: MIT - do anything with the code, but don't blame me if it does not work.

Support: if you find any problems with this module, email / tweet / open issue on Github

MIT License

Copyright (c) 2016 Gleb Bahmutov <gleb.bahmutov@gmail.com>

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

You can’t perform that action at this time.