git-semver
v0.0.4
Published
Manage semantically versioned git repositories
Downloads
11
Readme
git-semver
Manage git repositories with semantic versioning
git-semver
is a node module (and command line program) for managing git
repositories using semantic versioning. It's basically just a nice git API
that understands semantic versioning.
Example
Open a local repository, select the latest tag that matches "~1.1.8" and check it's contents out into the repository's work tree.
var git = require('git-semver');
git.repository('path/to/repository')
.latest('~1.1.8')
.checkout(function (err, ref) {
if (err) {
console.log(err);
process.exit(1);
}
});
API
The API is built around events and streams. Most methods
return an event emitter and accept an optional callback that fires once the
underlying emitter emits an end
event or raises an error.
This allows for succinct code, that chains multiple methods (hello demeter) synchronously and waits until the asynchronous operations finish.
Most operations start from the repository class.
Once instantiated the repository tries to resolve it's .git
directory and
– it its not a "bare" repository – the work tree.
License
Copyright (c) 2014 Jonas Pommerening
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.