gpub
Deploy github sites with ease.
Installing
npm install -g gpub
Process
- clean the working copy.
- checkout the source branch.
- install npm dependencies.
- run
npm run-script build
. - move
dist/
to a temporary directory. - checkout dist branch.
- remove contents.
- copy
dist/
contents - commit changes
- push to remote dist branch
- checkout source branch
Prerequisites
- You'll execute this script as a user with push/pull access to the repository.
- Your project is compatible with npm.
- You have a
build
script defined in yourpackage.json
. - You have git installed.
- Your build script outputs a
dist
directory. - If you're on a mac, you'll need to have GNU's
readlink
on your path (google homebrew gnu readlink for more info).
Usage
gpub [OPTIONS]
Options
--repo-dir <path>
(required) -<path>
must be a directory.--src-branch <branch>
(defaults tomaster
) -<branch>
must be an existing branch.--dist-branch <branch>
(defaults togh-pages
) -<branch>
must be an existing branch.
Example
gpub --repo-dir /tmp/some-repo-dir --src-branch src --dist-branch master
License
ISC