Thin Q promise wrapper for Git.
Promise-based wrapper based on Q that provides an asynchronous interface to Git.
The motivation behind this project was to create a promise wrapper for Git to be used when scripting Travis-CI deployments.
With npm do:
npm install git-q --save
var GitQ = require('git-q'),
gitQ = new GitQ();
gitQ
.setUserInfo()
.writeGitCredentials()
.setRemoteUrl('https://...')
.fetch(true)
.tag({ a: '1.0.1', m: 'Commit message associated with tag' })
.pushTags()
.catch(function(){
// Handle any errors from any of the above steps
})
.done();Initialise a GitQ wrapper object for Git.
Sets user name and email address globally to be available with every Git command to be used.
If no parameters are passed, name and email are fetched from the environment variables GIT_NAME and GIT_EMAIL
respectively. These two environment variables are set by the Travis-CI build environment.GI
Stores current user's credentials for the given repository token to disk. Method assumes that repository
token always belongs to github.com.
Sets a remote url against a remoteName which defaults to origin. This method runs the following Git command:
git remote set-url <remoteName> <url>
Runs git fetch with the --tags option if tags is true.
// Fetches all branch heads and all commits.
git fetch
// Fetches all tags and commits. Will not update branch heads.
git fetch --tags
Runs git tag. If options is an Object, method will assume it is a collection of annotated tags and append
it to the git tag command after flattening the structure. If options is a string, command will use the latter
and run it as a lightweight tag.
// Lightweight Tags
git tag v1.4-lw
// Annotated Tags
git tag -a v1.4 -m 'my version 1.4'
Pushes tags to a repository by runningi the git command:
git push --tags
MIT