stop-build

Exits with non-zero code if there are modified Git files

Why

Sometimes we commit to the Git repo files that are generated by the build step, like dist/app.js. We expect the developer to run the npm run build before committing the source files, but often I forget. Setting up the pre-commit also does not help much - the check runs too late.

The CI runs npm run build step, but we do not often check if there are changed files, which means there is a discrepancy. This tool actually checks and stops the build if there are changed files on CI.

Install

Install as a dev tool

npm i -D stop-build

Use

Add to your CI script after the build step. If the build step changes files that are Git tracked, the stop-build command will exit with non-zero status breaking the build. For example, .travis.yml file

script:
  - npm run build
  - $(npm bin)/stop-build

Prints changes and exits with code 1 if any found

⚠️ there are 2 changed files
M package.json
M src/index.js

Small print

Author: Gleb Bahmutov <[email protected]> © 2016

• @bahmutov
• glebbahmutov.com
• blog

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 <[email protected]>

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.