resin-vcs
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:
$ npm install --save resin-vcs
Documentation
- vcs
- .initialize(directory) ⇒
Promise
- .clone(url, directory) ⇒
Promise
- .associate(directory, url) ⇒
Promise
- .getApplicationName(directory) ⇒
Promise.<(String|undefined)>
- .initialize(directory) ⇒
Promise
vcs.initialize(directory) ⇒ Kind: static method of vcs
Summary: Initialize a directory with git
Access: public
Param | Type | Description |
---|---|---|
directory | String |
directory |
Example
vcs
Promise
vcs.clone(url, directory) ⇒ 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
vcs
Promise
vcs.associate(directory, url) ⇒ 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
vcs
Promise.<(String|undefined)>
vcs.getApplicationName(directory) ⇒ 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
vcs -> if applicationName? console
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:
$ gulp 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:
$ gulp lint
License
The project is licensed under the MIT license.