https://github.com/douglasduteil/node-git-deployor

A git pusher helper in node.
https://github.com/douglasduteil/node-git-deployor

Last synced: 25 days ago
JSON representation

A git pusher helper in node.

• Host: GitHub
• URL: https://github.com/douglasduteil/node-git-deployor
• Owner: douglasduteil
• License: wtfpl
• Created: 2014-09-26T16:30:08.000Z (about 10 years ago)
• Default Branch: master
• Last Pushed: 2018-02-23T15:27:27.000Z (almost 7 years ago)
• Last Synced: 2024-10-18T07:39:54.058Z (about 2 months ago)
• Language: JavaScript
• Size: 16.6 KB
• Stars: 1
• Watchers: 3
• Forks: 2
• Open Issues: 1
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# node-git-deployor [![NPM version][npm-image]][npm-url]

> A git pusher helper in node. 

## Install

```sh

$ npm install --save-dev node-git-deployor

```

## Usage

```js

'use strict';

var pkg = require('package.json');

var Deployor = require('node-git-deployor');

function publishBuiltFiles() {

  var distWorkspace = Deployor.cloneRepoBranch({

    orphan: true,

    branch: 'dist',

    cloneLocation: '/tmp/dist'

  });

  distWorkspace.extraCleanUp();

  distWorkspace.copy('./dist');

  distWorkspace.commit('Update ' + new Date().toISOString());

  distWorkspace.tag('v' + pkg.version);

  distWorkspace.push();

}

function publishNewSourceRelease() {

  var srcWorkspace = new Deployor();

  srcWorkspace.commit('chore(release): v' + pkg.version);

  srcWorkspace.tag('src' + pkg.version);

  srcWorkspace.push();

}

```

## API

### new Deployor([options])

#### options

Type: `Object`

Options to pass to the Deployor.

#### options.cwd

Type: `String`

Default: `process.cwd()`  

`cwd` of the input folder

#### options.branch

Type: `String`

Default: `master`

The branch to deploy to.

#### options.orphan

Type: `Boolean`

Default: `false`

Setting this to `true` will force the use of a orphan branch for the deployment. 

- *TODO(douglasduteil): confirm this*

#### options.cloneLocation

Type: `String`

Default: `path.join('/', 'tmp', path.basename(process.cwd()))`

The path where the temporal deployed file will be cloned.

### Deployor instance `deployor`

#### deployor.extraCleanUp

- *TODO(douglasduteil): document this*

#### deployor.copy

- *TODO(douglasduteil): document this*

#### deployor.commit

- *TODO(douglasduteil): document this*

#### deployor.tag

- *TODO(douglasduteil): document this*

#### deployor.push

- *TODO(douglasduteil): document this*

### Deployor.cloneRepoBranch([options])

- *TODO(douglasduteil): document this*

## License

    Copyright © 2014 Douglas Duteil 

    This work is free. You can redistribute it and/or modify it under the

    terms of the Do What The Fuck You Want To Public License, Version 2,

    as published by Sam Hocevar. See the LICENCE file for more details.

[npm-url]: https://npmjs.org/package/node-git-deployor

[npm-image]: http://img.shields.io/npm/v/node-git-deployor.svg