file-deploy
v1.1.0
Published
deploy file to git branch
Downloads
11
Readme
file-deploy
This is a command for deploying generated files to a git branch. Unlike the git-subtree approach, it does not require the generated files be committed to the source branch.
Installation
npm install --save-dev file-deploy
Usage
deploy [args]
options
You can specify options in .deployinfo
.
It must be valid JSON file.
The example is:
{
"directory": "dist/",
"repo": "[email protected]:ineo6/file-deploy.git",
"username": "deployBot",
"email": "[email protected]",
"branch": "gh-pages"
}
Alternatively, options can be specified in package.json
:
{
"config": {
"deploy-info": {
/* your config here */
}
}
}
.deployinfo
has precedence, if it does not exist, then package.json
will be used.
directory
The subdirectory to deploy. Defaults to dist/
.
branch
The branch that will receive the deploy. Defaults to gh-pages
.
repo
The repo to push the deploy to. Defaults to origin
.
username
The username that will be associated with the deploy commit.
email
The email that will be associated with the deploy commit.