Skip to content
Plugin for semantic-release that only allows publishing from a specific NodeJS version
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.
test
.gitignore
.npmrc
.travis.yml
README.md
index.js
package.json

README.md

condition-node-version

Plugin for semantic-release that only allows publishing from a specific NodeJS version

NPM

Build status dependencies devdependencies semantic-release standard

Why?

You want to publish your module to NPM using the semantic-release task, but only if the unit tests on all Node versions pass. TravisCI does not have "build-after-all" step, see this issue and the module travis-after-all that tries to get around this. Unfortunately, this is unreliable. My builds often time out, with some builds in the matrix waiting on each other in a circle.

This is why I wrote this plugin.

Install and configuration

npm install --save-dev condition-node-version

Add the release configuration to the package.json, just like semantic-release docs show. All we need is to specify this plugin and the exact version of Node we want to publish from

"release": {
  "verifyConditions": {
    "path": "condition-node-version",
    "node": "4.2.2",
    "verbose": true // optional
  }
}

Make sure the same Node version is listed in your .travis.yml file

node_js:
  - '5'
  - '4.2.2'
  - '0.12'
after_success:
  - npm run semantic-release

Note that we no longer have to wait on multiple travis jobs, thus it is simple after_success call.

To combine this plugin with Travis environment check use a list of plugins. For example, to check Travis environment and Node version

npm install --save-dev @semantic-release/condition-travis

Then list the plugins in package.json

"release": {
  "verifyConditions": [
    {
      "path": "@semantic-release/condition-travis"
    }, {
      "path": "condition-node-version",
      "node": "4.2.2"
    }
  ]
}

You can use semantic ranges in the condition, for example

"release": {
  "verifyConditions": [
    {
      "path": "condition-node-version",
      "node": ">=4.2.0"
    }
  ]
}

The check is done using semver.satisfies.

Notes

Because the module can be published from a single version of NodeJS, while the other version builds break, you should keep the CI build green to make sure a published version of your module is really working for everyone.

Related

Small print

Author: Gleb Bahmutov © 2015

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

Spread the word: tweet, star on github, etc.

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

MIT License

Copyright (c) 2015 Gleb Bahmutov

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.