built-version

Generates a JSON file with git SHA and latest module version

Why

Getting accurate and complete build version information is crucial for quick debugging. For NPM packages, this should include Git commit id and module version. This module gets both and saves into a file.

During execution you can load the file using version-middleware or similar module and return the version information.

Install and use

Best to use in combination with semantic-release.

npm i -D built-version

Then run this module right before NPM publish command to save a file. Change the semantic release script command in package.json to

{
  "scripts": {
    "built": "built-version --file build.json",
    "semantic-release": "semantic-release pre && npm run built && npm publish && semantic-release post"
  }
}

If deploying directly from the CI server, add the build.json to the commit before pushing code. See the Deployed Commit blog post on how to do this.

Related

• include-version
• ggit
• latest-version-or-tag

Small print

Author: Gleb Bahmutov <[e-mail]> © 2017

• @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) 2017 Gleb Bahmutov <[e-mail]>

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.