svn-release

svn-release
===========








* Introduction
* Installation
* Usage
* API
* CLI
* License

Introduction

A subversion release toolkit module for node.js projects.

Installation

With npm do:

``
npm install svn-release
`

or, to make use of modules command line interface:

`
npm install -g svn-release
`

Usage

svn-release can be used in a programmatic or in a command line fashion.

$3

#### Performing releases

`javascript
var pkg = require('./package.json'),
svnOptions = {cwd: '.'},
releaseOptions = new SvnRelease.SvnDefaults(pkg.version)
.releaseOptions({dist: 'dist'});

return new SvnRelease(svnOptions)
.release(releaseOptions);
`

$3

#### Displaying help information

svn-release --help:

`
Usage: svn-release [options...]

Commands:

branch [options] create new branch, based on current working copy
release [options] create new release, based on current working copy

Options:

-h, --help output usage information
-V, --version output the version number
-I, --interactive perform branch or release tasks in interactive mode
`

#### Performing releases

svn-release release --help:

`
Usage: release [options]

create new release, based on current working copy

Options:

-h, --help output usage information
-n, --release-name [name] overrides default release version
-r, --release-version [version] overrides default release version
-N, --next-version [version] overrides next version
-d, --dist [dist-folder] include distribution folder on release
-R, --releases [path] relative path to releases (tags)
`

#### Branching

svn-release branch --help :

`
Usage: branch [options]

create new branch, based on current working copy

Options:

-h, --help output usage information
-n, --branch-name [name] override default branch name
-b, --branch-version [version] override default branch version
-N, --next-version [version] override next version
-B, --branches [path] relative path to branches
`

License

svn-release` is available under the following licenses:

* Apache 2.0