Git Product home page Git Product logo

ghpages's Introduction

@dmnsgn/ghpages

experimental

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 @dmnsgn/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.

ghpages's People

Contributors

mattdesl avatar dmnsgn avatar

Watchers

James Cloos avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.