lu.svn.release/README.md

Convenience SVN release helper module

lu.svn.release
====

Convenience SVN release module

Simple release plugin for apps with Subversion VCS

Installation
----

    npm install lu.svn.release

Or if you want to use the module from CLI:

    npm install -g lu.svn.release

Usage
====

```javascript
var svnRelease = require('lu.svn.release');

svnRelease.performTag({}, function(error) {
    //your error handling code goes here
})
```

```
lusvnrelease --username <username> --password <password>
```

Requirements
====

Several requirements need to be met regarding `package.json` content:

* `"version"` field is required, it has to conform to semver scheme
* `"repository"` field is required, `"url"` field should point to a valid trunk url

As of now, lu.svn.release works with default svn structure:

```
source-root/
    -trunk
    -tags
```

Command line params
====

lu.svn.release version scheme is based on semver module.

Current release version is being read from `package.json` file.
Target trunk version can be specified in one of the following ways :

*`--patch` - increment patch component
*`--minor` - increment minor component, set patch component to 0
*`--major` - increment major component, set minor and patch components to 0
*`--version <version>` - set trunk version to `<version>`

LICENSE
===

`lu.svn.release` is available under the following licenses:

  * MIT