diff --git a/README.md b/README.md index ca02fa9..32f294b 100644 --- a/README.md +++ b/README.md @@ -6,7 +6,7 @@ Generate a release for a project following semver using nodejs and gitflow [![Generate Release on NPM](https://img.shields.io/npm/v/generate-release.svg?style=flat-square)](https://www.npmjs.com/package/generate-release) [![Generate Release uses the MIT](https://img.shields.io/npm/l/generate-release.svg?style=flat-square)](https://opensource.org/licenses/MIT) -Current Version: 0.7.7 +Current Version: 0.8.0 Requires NodeJS v4.0.0 or greater @@ -88,13 +88,13 @@ run `generate-release --help` to see this as well. -l, --skip-git-pull Do not pull from origin and rebase master and dev. Default: Do pull -s, --skip-git-push Do not push to origin when complete. Default: Do push -d, --release-file Path to your .release.json file. Default: ./.release.json - -m, --set-release-message Prompt to write a release message. Default: Release {version} + -m, --set-release-message Prompt to write a release message. Default: Do no prompt, use "Release {version}" -o, --remote Change the remote. Default: origin **Release File** By default, the following options can be set in a `.release.json` file. The following -is an example with all files set. +is an example with all default options set. { "package_file_location": "./package.json", @@ -102,7 +102,7 @@ is an example with all files set. "skip_git_pull": false, "skip_git_push": false, "set_release_message": true, - "release": "origin", + "remote": "origin", "pre_commit_commands": [], "post_commit_commands": [], "post_complete_commands": [], @@ -142,6 +142,19 @@ following assumptions are made: ] } +Usage on a Non NPM Based Repo +----------------------------- + +It's quite simple to use this on a non NPM based repo. The only npm specific aspect baked into Generate Release is the +usage of the package.json file. In fact, you are able to use any json file which maintains a version property. If you +are working on a PHP project which uses [Composer](https://getcomposer.org), the composer.json already has the required +property. Either call generate-release with `-p composer.json` or set the `package_file_location` property of your +`.release.json` file. + +If your project does not already contain a json file which maintains a version, you just use the `.release.json` +file! Just put a version property in the file and set `package_file_location` to ".release.json". + + Roadmap ------- diff --git a/main/lib/Options.js b/main/lib/Options.js index 8070cda..78bd7a7 100644 --- a/main/lib/Options.js +++ b/main/lib/Options.js @@ -7,16 +7,12 @@ */ (function() { - var Minimist, Options, Path, existsSync, extend, options, pick; + var Minimist, Options, Path, existsSync, options; existsSync = require('exists-sync'); Path = require('path'); - pick = require('object.pick'); - - extend = require('extend'); - Minimist = require('minimist'); options = { diff --git a/package.json b/package.json index d2e3a98..d3f4380 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "generate-release", - "version": "0.7.7", + "version": "0.8.0", "description": "Generate a release using git-glow", "engines": { "node": ">=4.0.0" @@ -42,15 +42,11 @@ "dependencies": { "bluebird": "^3.1.2", "exists-sync": "0.0.3", - "extend": "^3.0.0", "glob": "^7.0.4", "iniparser": "^1.0.5", "inquirer": "^1.1.0", - "js-yaml": "^3.6.1", "minimist": "^1.2.0", - "object.pick": "^1.1.2", "observatory": "^1.0.0", - "parse-spawn-args": "^1.0.2", "rmdir": "^1.2.0" }, "devDependencies": { @@ -64,7 +60,6 @@ "istanbul-coveralls": "^1.0.3", "mocha": "^2.3.4", "sinon": "^1.17.4", - "temp": "^0.8.3", - "uglify-js": "^2.6.2" + "temp": "^0.8.3" } } diff --git a/src/lib/Options.coffee b/src/lib/Options.coffee index c60eb4f..a02f683 100644 --- a/src/lib/Options.coffee +++ b/src/lib/Options.coffee @@ -6,8 +6,6 @@ existsSync = require 'exists-sync' Path = require 'path' -pick = require 'object.pick' -extend = require 'extend' Minimist = require 'minimist' options =