项目作者: bahmutov

项目描述 :
Plugin for semantic-release that only allows publishing from a specific NodeJS version
高级语言: JavaScript
项目地址: git://github.com/bahmutov/condition-node-version.git
创建时间: 2015-12-03T16:15:13Z
项目社区:https://github.com/bahmutov/condition-node-version

开源协议:

下载


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

  1. 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

  1. "release": {
  2. "verifyConditions": {
  3. "path": "condition-node-version",
  4. "node": "4.2.2",
  5. "verbose": true // optional
  6. }
  7. }

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

  1. node_js:
  2. - '5'
  3. - '4.2.2'
  4. - '0.12'
  5. after_success:
  6. - 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

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

Then list the plugins in package.json

  1. "release": {
  2. "verifyConditions": [
  3. {
  4. "path": "@semantic-release/condition-travis"
  5. }, {
  6. "path": "condition-node-version",
  7. "node": "4.2.2"
  8. }
  9. ]
  10. }

You can use semantic ranges in the condition, for example

  1. "release": {
  2. "verifyConditions": [
  3. {
  4. "path": "condition-node-version",
  5. "node": ">=4.2.0"
  6. }
  7. ]
  8. }

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.

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.