utterson-publish v0.1.1

Utterson-Publish

Git publishing module for flexible and static blog generation framework Utterson.

Installation

npm install utterson-publish

Basic Usage

Every method is returning a Promise and is chainable.

var publisher = require('utterson-publish');

Getting a repository

publisher.getRepo(filePath, sourceRemote, sourceBranch)
    .then(function (repo) {
        console.log(repo)
    });

Note: initializes a new repo or returns a existing once from the given path

Checking for new commits

publisher.checkForNewCommits(repository)
    .then(function (repo) {
        console.log(repo.hasNewCommits);
    });

Note: should be chained with the getRepo method

Checking out new Files

publisher.checkoutNewFiles(repo)
    .then(function (repo) {
        console.log(repo.hasNewFiles);
    });

Note: should be chained with the getRepo method

Publishing files to a repo

publisher.getRepo(filePath, destinationRemote, destinationBranch)
    .then(publisher.publish);

License

MIT-Licensed