Merge pull request #5 from mcfly-io/yana/add-mcfly-github

README.md

@@ -27,13 +27,25 @@ Optionnaly additional files can be added to also have their version bumped
 }
 ```
 
-Note that the path for the `--files` option is relative to your current root directory
+> **NOTE**    
+> the path for the `--files` option is relative to your current root directory
 
 Then, to publish a new version execute the following command:
+
 ```bash
 npm run release
 ```
 
+By default, this will publish a patch version, if you want to control the semver option you can pass an optional 'patch', 'minor' or 'major' type argument.
+
+**Example :**
+
+```bash
+npm run release -- --type=minor
+```
+
+> **NOTE**    
+> The double `--` is necessary, this is how npm script propagates its arguments
 
 
 [npm-image]: https://badge.fury.io/js/mcfly-semantic-release.svg

bin/mcfly-semantic-release.js

@@ -7,7 +7,7 @@ const args = require('yargs').argv;
 const chalk = require('chalk');
 const changelogScript = require('../lib/changelog-script');
 const gitHelper = require('../lib/githelper');
-const githubHelper = require('../lib/githubHelper');
+const githubHelper = require('mcfly-github');
 const inquirer = require('inquirer');
 const path = require('path');
 const versionHelper = require('../lib/versionHelper');

package.json

@@ -1,59 +1,60 @@
 {
-    "name": "mcfly-semantic-release",
-    "version": "1.0.7",
-    "description": "A cli tool to bump version and publish to github",
-    "bin": {
-        "mcfly-semantic-release": "./bin/mcfly-semantic-release.js"
-    },
-    "dependencies": {
-        "bluebird": "^3.4.0",
-        "chalk": "^1.1.3",
-        "github": "^1.1.2",
-        "inquirer": "^1.0.3",
-        "jsonfile": "^2.3.1",
-        "lodash": "4.13.1",
-        "memory-stream": "0.0.3",
-        "node-jsxml": "^0.7.0",
-        "semver": "^5.1.0",
-        "simple-git": "^1.37.0",
-        "strip-json-comments": "^2.0.1",
-        "yargs": "^4.7.1"
-    },
-    "devDependencies": {
-        "chai": "^3.5.0",
-        "coveralls": "^2.11.9",
-        "eslint": "^2.10.2",
-        "eslint-plugin-json": "^1.2.0",
-        "eslint-plugin-nodeca": "^1.0.3",
-        "istanbul": "^0.4.3",
-        "mocha": "^2.5.3",
-        "sinon": "^1.17.4",
-        "sinon-chai": "^2.8.0"
-    },
-    "scripts": {
-        "eslint": "eslint .",
-        "lint": "npm run eslint",
-        "pretest": "npm run eslint",
-        "test": "npm run mocha",
-        "mocha": "istanbul cover --root . --include-all-sources -x **/coverage/** -x **/client/** -x **/files/** -x **/node_modules/** --dir ./coverage/mocha --report text --report text-summary --report lcov --print none  _mocha -- test/mocha/**/*.spec.js --reporter spec --timeout 10000",
-        "mocha:watch": "mocha test/mocha/**/*.spec.js -R nyan -w --timeout 10000",
-        "release": "node bin/mcfly-semantic-release.js"
-    },
-    "files": [
-        "lib",
-        "bin"
-    ],
-    "engines": {
-        "node": ">= 4.2.1 < 5"
-    },
-    "repository": {
-        "type": "git",
-        "url": "git+https://github.com/mcfly-io/mcfly-semantic-release.git"
-    },
-    "author": "",
-    "license": "MIT",
-    "bugs": {
-        "url": "https://github.com/mcfly-io/mcfly-semantic-release/issues"
-    },
-    "homepage": "https://github.com/mcfly-io/mcfly-semantic-release#readme"
-}
+  "name": "mcfly-semantic-release",
+  "version": "1.0.7",
+  "description": "A cli tool to bump version and publish to github",
+  "bin": {
+    "mcfly-semantic-release": "./bin/mcfly-semantic-release.js"
+  },
+  "dependencies": {
+    "bluebird": "^3.4.0",
+    "chalk": "^1.1.3",
+    "github": "^1.1.2",
+    "inquirer": "^1.0.3",
+    "jsonfile": "^2.3.1",
+    "lodash": "4.13.1",
+    "mcfly-github": "^1.0.2",
+    "memory-stream": "0.0.3",
+    "node-jsxml": "^0.7.0",
+    "semver": "^5.1.0",
+    "simple-git": "^1.37.0",
+    "strip-json-comments": "^2.0.1",
+    "yargs": "^4.7.1"
+  },
+  "devDependencies": {
+    "chai": "^3.5.0",
+    "coveralls": "^2.11.9",
+    "eslint": "^2.10.2",
+    "eslint-plugin-json": "^1.2.0",
+    "eslint-plugin-nodeca": "^1.0.3",
+    "istanbul": "^0.4.3",
+    "mocha": "^2.5.3",
+    "sinon": "^1.17.4",
+    "sinon-chai": "^2.8.0"
+  },
+  "scripts": {
+    "eslint": "eslint .",
+    "lint": "npm run eslint",
+    "pretest": "npm run eslint",
+    "test": "npm run mocha",
+    "mocha": "istanbul cover --root . --include-all-sources -x **/coverage/** -x **/client/** -x **/files/** -x **/node_modules/** --dir ./coverage/mocha --report text --report text-summary --report lcov --print none  _mocha -- test/mocha/**/*.spec.js --reporter spec --timeout 10000",
+    "mocha:watch": "mocha test/mocha/**/*.spec.js -R nyan -w --timeout 10000",
+    "release": "node bin/mcfly-semantic-release.js"
+  },
+  "files": [
+    "lib",
+    "bin"
+  ],
+  "engines": {
+    "node": ">= 4.2.1 < 5"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/mcfly-io/mcfly-semantic-release.git"
+  },
+  "author": "",
+  "license": "MIT",
+  "bugs": {
+    "url": "https://github.com/mcfly-io/mcfly-semantic-release/issues"
+  },
+  "homepage": "https://github.com/mcfly-io/mcfly-semantic-release#readme"
+}