Merge pull request #11 from mcfly-io/feat-prod

README.md

@@ -6,6 +6,7 @@
 
 [![NPM][npm-nodei-image]][npm-nodei-url]
 
+
 ## Installation
 ```bash
 npm i --save-dev mcfly-semantic-release
@@ -19,7 +20,13 @@ In your `package.json`
 }
 ```
 
-Optionnaly additional files or files patterns (globs) can be added to also have their version bumped
+Running release will do the following: 
+- Bumps version. 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' to the `--type` argument.
+- Updates version in files: by default it will only update the root level `package.json`. Optionnaly use `--file` to specify file paths or files patterns (globs) that can have their version updated as well.  Files can be `package.json` files or `config.xml` files
+- Commit the changed files with a standard commit message. Default message is `chore(app): Version <version number>`. Use `--production` to suffix the commit message with the work `production` (can be later used in CI)
+- Generates changlog based on Angular standard commit messages.
+- Generate a tag with the version number. 
+- Generates a github release with the version number.
 
 ```json
 "scripts": {
@@ -36,8 +43,6 @@ Then, to publish a new version execute the following command:
 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

bin/mcfly-semantic-release.js

@@ -14,18 +14,9 @@ const inquirer = require('inquirer');
 const path = require('path');
 const versionHelper = require('../lib/versionHelper');
 const args = require('yargs')
-.option('files', {
-    type: 'array',
-    desc: 'Files and files patterns to change'
-}).argv;
-// var files = args.files ? [].concat(args.files) : [];
-
-// if (files.length === 0) {
-//     files.push('./package.json');
-// }
-// files = _.map(files, (file) => {
-//     return path.isAbsolute(file) ? file : path.join(process.cwd(), file);
-// });
+    .option('files', { type: 'array',  desc: 'Files and files patterns to change'})
+    .option('production', {type: 'boolean', desc: 'Generate production commit message'})
+    .argv;
 
 var files;
 var msg = {};
@@ -110,7 +101,7 @@ fileHelper.getFiles(args.files)
     })
     .then((msg) => {
         console.log(chalk.yellow('Committing version...'));
-        return gitHelper.commitVersion(msg.nextVersion)
+        return gitHelper.commitVersion(msg.nextVersion, args.production)
             .then(() => msg);
     })
     .delay(1000)

lib/gitHelper.js

@@ -18,12 +18,13 @@ var getCurrentBranch = function() {
         });
 };
 
-var commitVersion = function(version) {
+var commitVersion = function(version, production) {
+    let commitMessage = `chore(app): Version ${version} ${production ? ' production' : ''} `;
     return Promise
         .fromCallback((cb) => {
             git
                 .add('./*')
-                .commit('docs(changelog): version ' + version)
+                .commit(commitMessage)
                 .addAnnotatedTag(version, 'v' + version)
                 .push('origin', 'master')
                 .pushTags('origin', cb);