Grunt plugin to take a build from dist on your current branch and put it into another branch, e.g. gh-pages, without merging. Ideal for when builds should be stored in orphan branches.
npm install && grunt build, then look at the
This plugin requires Grunt
If you haven't used Grunt before, be sure to check out the Getting Started guide, as it explains how to create a Gruntfile as well as install and use Grunt plugins. Once you're familiar with that process, you may install this plugin with this command:
npm install grunt-build-gh-pages --save-dev
- You are using version of Node (0.8.19+) and NPM (1.1.6+) that support peer dependencies.
- This task is run after you have run the build task (or as the end part of your build task)
- The full build must be in the distribution directory at the beginning of this task.
- A separate
--orphanbranch that has just the builds exists
- You want to auto push to that separate branch when you run this task!
The "buildGhPages" task
In your project's Gruntfile, add a section named
buildGhPages to the data object passed into
dist: The directory the build is placed in. This directory should be gitignored in your current branch and the build branch.
- Default: "dist"
build_branch: The name of the branch the build should be commited to. This branch should exist. Ideally it should be an orphan branch.
- Default: "gh-pages"
pull: Whether you want to the a
git pull --rebaseon the build branch before modifying it. Use this if mutliple people can build to the repo.
- Default: true
exclude: An array of other directories besides
node_modulesyou wish to exclude. These directories should be in the
.gitignoreof both branches.
copy_hidden: If this value is truthy. Hidden files will be copied from the root dist directory to the final build directory. Hidden files in subfolders of dist are automatically copied.
- Default: false
In this example, the default options are used to do something with whatever. So if the
testing file has the content
Testing and the
123 file had the content
1 2 3, the generated result would be
Testing, 1 2 3.
In lieu of a formal styleguide, take care to maintain the existing coding style. Add unit tests for any new or changed functionality. Lint and test your code using Grunt.
- 0.0.1 - 2013-04-17 - patches
- 0.0.2 - 2013-04-27 - patches
- 0.0.3 - 2013-05-04 - patches
- 0.1.0 - 2013_08_08 - features
- 0.1.1 - 2013-10-09 - patches
- 0.1.2 - 2013-12-04 - patches
- 0.1.4 - 2014-01-16 - patches
- 0.1.5 - 2014-01-16 - patches
- 0.1.6 - 2014-01-16 - patches
- 0.1.7 - 2014-01-16 - patches
- 1.0.0 - 2014-02-24 - backward incompatibilities
- 1.0.1 - 2014-02-25 - patches
- 1.0.2 - 2014-03-04 - patches
- 1.0.3 - 2014-03-04 - patches
- 1.0.4 - 2015-05-07 - patches
- 1.0.5 - 2015-08-22 - patches
undefined Created: 2015-08-22 07:52:41_