resin-io/resin-vcs

Name: resin-vcs

Owner: Resin.io

Description: A layer between Resin.io and version control systems.

Created: 2015-03-12 14:36:45.0

Updated: 2016-11-14 00:10:23.0

Pushed: 2016-01-11 17:20:32.0

Homepage: null

Size: 37

Language: CoffeeScript

GitHub Committers

User	Most Recent Commit	# Commits

Other Committers

User	Email	Most Recent Commit	# Commits

README

resin-vcs

Join our online chat at

A layer between Resin.io and VCS.

Role

The intention of this module is to provide an extensible layer between Resin.io and version control systems, such as git.

Systems

Currently this module only supports git, but will be extended in the future.

Installation

Install resin-vcs by running:

m install --save resin-vcs

Documentation

• vcs
• .initialize(directory) ? Promise
• .clone(url, directory) ? Promise
• .associate(directory, url) ? Promise
• .getApplicationName(directory) ? Promise.<(String\|undefined)>

vcs.initialize(directory) ? Promise

Kind: static method of vcs
Summary: Initialize a directory with git
Access: public

| Param | Type | Description | | — | — | — | | directory | String | directory |

Example

initialize('foo/bar')

vcs.clone(url, directory) ? Promise

Kind: static method of vcs
Summary: Clone a git repository to a directory
Access: public

| Param | Type | Description | | — | — | — | | url | String | repository url | | directory | String | directory |

Example

clone('https://github.com/resin-io/resin-vcs.git', 'foo/bar')

vcs.associate(directory, url) ? Promise

Kind: static method of vcs
Summary: Add a resin remote to a git repository
Access: public

| Param | Type | Description | | — | — | — | | directory | String | directory | | url | String | repository url |

Example

associate('foo/bar', 'jviotti@git.resin.io:jviotti/foobar.git')

vcs.getApplicationName(directory) ? Promise.<(String\|undefined)>

Kind: static method of vcs
Summary: Get the associated application name from a repository
Returns: Promise.<(String\|undefined)> - application name
Access: public

| Param | Type | Description | | — | — | — | | directory | String | directory |

Example

getApplicationName('foo/bar').then (applicationName) ->
if applicationName?
    console.log(applicationName)

Support

If you're having any problem, please raise an issue on GitHub and the Resin.io team will be happy to help.

Tests

Run the test suite by doing:

lp test

Contribute

• Issue Tracker: github.com/resin-io/resin-vcs/issues
• Source Code: github.com/resin-io/resin-vcs

Before submitting a PR, please make sure that you include tests, and that coffeelint runs without any warning:

lp lint

License

The project is licensed under the Apache 2.0 license.