Awesome Open Source
Awesome Open Source

branchsite

Heavily inspired by np, this provides a complimentary tool that eases the process of publishing your static files to a branch (e.g. gh-pages).

Build Status Greenkeeper badge Commitizen friendly styled with prettier semantic-release

Install

$ yarn global add branchsite

Usage

$ bs --help

    bs - CLI tool for publishing your static website to a separate branch

    USAGE

      bs

    OPTIONS

      --any-branch            Allow pushing from any branch                         optional
      --no-yarn               Don't use Yarn                                        optional
      --no-publish            Don't publish                                         optional
      --no-cleanup            Will skip the clean up stage                          optional
      --hook <hook>           NPM hook that builds your static website              optional
      --directory <path>      Directory that will be pushed to separate branch      optional
      --branch <branch>       Branch that will be used for deployment               optional

    GLOBAL OPTIONS

      -h, --help         Display help
      -V, --version      Display version
      --no-color         Disable colors
      --quiet            Quiet mode - only displays warn and error messages
      -v, --verbose      Verbose mode - will also output debug messages

Contributing

See our contributing guide to learn about our development process.

Changelog

Every release is automatically documented on the GitHub releases page using semantic-release.

License

MIT


Get A Weekly Email With Trending Projects For These Topics
No Spam. Unsubscribe easily at any time.
javascript (70,927
nodejs (3,867
cli (1,840
deployment (237
publishing (83
node-module (67
gh-pages (35
static-website (16