https://github.com/jmendiara/snapver

Snapshot / canary project lifecycle management
https://github.com/jmendiara/snapver

Last synced: 4 months ago
JSON representation

Snapshot / canary project lifecycle management

• Host: GitHub
• URL: https://github.com/jmendiara/snapver
• Owner: jmendiara
• License: mit
• Created: 2014-11-29T11:48:31.000Z (over 10 years ago)
• Default Branch: develop
• Last Pushed: 2014-12-28T15:42:08.000Z (over 10 years ago)
• Last Synced: 2025-02-10T12:18:47.696Z (4 months ago)
• Language: JavaScript
• Homepage:
• Size: 430 KB
• Stars: 1
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# snapver - Snapshot your code

[![npm version](https://badge.fury.io/js/snapver.svg)](http://badge.fury.io/js/snapver)

[![Build Status](https://travis-ci.org/jmendiara/snapver.svg)](https://travis-ci.org/jmendiara/snapver)

[![Coverage Status](https://img.shields.io/coveralls/jmendiara/snapver.svg)](https://coveralls.io/r/jmendiara/snapver?branch=develop)

[![Dependency Status](https://david-dm.org/jmendiara/snapver.png)](https://david-dm.org/jmendiara/snapver)

[![devDependency Status](https://david-dm.org/jmendiara/snapver/dev-status.svg)](https://david-dm.org/jmendiara/snapver#info=devDependencies)

Introducing the snapshot project lifecycle managing for easy preintegrations and canary channels

## Installation

```sh

npm install -g snapver

```

## Usage

Start a patch version. Can be `patch`, `minor`, `major`

```sh

$ snapver start patch

```

Make a release in git

```sh

$ snapver release

```

Help please!

```sh

$ snapver --help

```

## API

```js

var snapver = require('snapver');

snapver({

  branch: 'release' //give additional config

}).start('patch', function(err, version) {

  console.log('New Version %s started', version);

});

//Dual API, node callbacks and promises

//It will use `.snaprc` [commented] json file in your working directory 

snapver().release().then(function(version) {

  console.log('Version %s released', version);

});

```