@mattdesl/ghpages
v1.2.0
Published
quick script which deploys to gh-pages branch
Downloads
18
Maintainers
Readme
@mattdesl/ghpages
A small, personalized shell script which switches to gh-pages
branch, runs npm run build
, commits and pushes the new changes, and then switches back to your previous branch.
Install
npm install @mattdesl/ghpages -g
Usage
cd
to your module directory. Make sure it has a build
script in package.json
:
{
"scripts": {
"build": "browserify index.js > bundle.js"
}
}
Now, with a clean git working directory, and on the default (i.e. master
) branch, just run the following to push to gh-pages:
ghpages
This will check out gh-pages
branch (creating it if necessary), merge master into it, npm run build
, then commit and push the new build and switch back to master.
In some cases, you may need to modify the .gitignore
of your gh-pages
branch to ensure that bundle.js
is pushed to git. You can pass the -i
flag which will also remove bundle.js
from your current directory's .gitignore
before committing.
ghpages -i
License
MIT, see LICENSE.md for details.