version-middleware

Express.js middleware that returns NPM version and Git SHA

Use

npm install --save version-middleware

const version = require('version-middleware')
app.get('/version', version())

Then GET /version, returns JSON with

{
  "version": "...",
  "git": "short SHA",
  "started": "Date ISO string"
}

The returned JSON data will have cache-control header that prevents any caching on the client

cache-control: max-age=0, no-cache, no-store, no-transform, must-revalidate

Pass send

If you do not want to assume res.send function, you can pass send function to be called with results. For example when using micro server you send result using send function.

const {send} = require('micro')
const version = require('version-middleware')()
micro(async(req, res) => {
  version(info => {
    send(res, info)
  })
})

Built version file

You can save build information during CI test run using built-version into file build.json. If this file is found, it will be used instead of getting Git sha and reading version from the package.json file.

Related

• koa-version-header
• built-version

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.