{"bugs":{"url":"https://github.com/shinnn/gulp-gh-pages/issues"},"dist":{"shasum":"ec56175609370bba3f447b388ec0dcb8462da22c","tarball":"https://registry.npmjs.org/gulp-gh-pages/-/gulp-gh-pages-0.6.0-4.tgz","fileCount":5,"integrity":"sha512-Thsxwq8okqXH7evs8gYIeGt7812/zyreudpv24rKvCrkfcdUZanYBek3Ox/jSa8AJhXbT1ODmwfy2oCC1kFAdg==","signatures":[{"sig":"MEUCIQC10YyKL7PgPEq5PqdjnAIcAKjrEcKLR5ouCceyZFCCJQIgBZOtaKptqprOWI8uHClL/qqoh7PX9t2VWsfhn5mpf8o=","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":12388,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJbaRoICRA9TVsSAnZWagAARrAQAI6b2f/iRMgBwp/7hcHQ\nr2/6uBGT/GUlytJgrczMx6bicaUkuPTZklnZTNBBoSkRmY5E2KGCpfeNQ7qI\nK+qRWypwEb22YCGCg2eWYpZHgMN+9h0d6li8R5LBVsEZu8Jb/LqSLgNOIpbT\nq9d7ak5+6QKxbdoG/BZl6RFhwCkTqXZMJocNra5L460ZU4H2UJpkd3FHL2cB\nAY9Jh0JL1v6KzifRabLY95hmw+Uux169xBtRch1Eb6YtSbjmNtFfjqQfg36B\nNwpxvacVq0NktDfWiKfiu9L+D0knc56S7/SInZrpBB+cwc28nQPe3Ao+YJG3\nmSm78Y0x9iiO858jEYio5JnHf//rRrboK4xmM1XRWvOtRD4v4CSlfzgMz8J7\n9iRPzyUMDGAbD9T8Xv5WlWvu7DcKrGvlUz3bpL6+pIHVfiUfEV+UxqnDC2qE\noBm03G+cY6qyqe9Z0fyDzgBzW9FSilWN5yzMv+dOR1FCje7pZWl/hw4umpBT\nC2HVJvkX8JgVgLSZubj7CHKVo9qSvUEMtoD9SkunT0rQe1WkV0queWGO+8t+\naCQf9tg9+lp35q8ikZ7MClxhmdjX7vTsceGorxcB9fLjhJ1nuZ41JNFm1RSw\nQkBh7ttTo3W4EB3RoZqP66v8Ndj+ta9aVveo+YA+5BPP/CQCRQpN/MFlvvyd\nI0bc\r\n=q3iC\r\n-----END PGP SIGNATURE-----\r\n"},"name":"gulp-gh-pages","files":["index.js","lib.js"],"author":{"url":"https://github.com/rowoot","name":"Micheal Benedict","email":"micheal@visionmasterdesigns.com"},"readme":"# gulp-gh-pages\n\n[![npm version](https://img.shields.io/npm/v/gulp-gh-pages.svg)](https://www.npmjs.com/package/gulp-gh-pages)\n[![Build Status](https://travis-ci.org/shinnn/gulp-gh-pages.svg?branch=master)](https://travis-ci.org/shinnn/gulp-gh-pages)\n[![Build status](https://ci.appveyor.com/api/projects/status/iskj8sml9luhkm21?svg=true)](https://ci.appveyor.com/project/ShinnosukeWatanabe/gulp-gh-pages)\n[![Coverage Status](https://img.shields.io/coveralls/shinnn/gulp-gh-pages.svg)](https://coveralls.io/github/shinnn/gulp-gh-pages)\n\n[gulp](http://gulpjs.com/) plugin to publish contents to [Github pages](https://pages.github.com/)\n\n## Installation\n\n[Use](https://docs.npmjs.com/cli/install) [npm](https://docs.npmjs.com/getting-started/what-is-npm).\n\n```\nnpm install --save-dev gulp@next gulp-gh-pages\n```\n\n## Usage\n\nDefine a `deploy` task in your `gulpfile.js` (as below) which can be used to push to `gh-pages` going forward.\n\n```javascript\nconst {src, task}= require('gulp');\nconst ghPages = require('gulp-gh-pages');\n\ntask('deploy', () => src('./dist/**/*').pipe(ghPages()));\n```\n\nNow, you should be able to call your task by doing:\n\n```\ngulp deploy\n```\n\n## API\n\n```javascript\nconst ghPages = require('gulp-gh-pages');\n```\n\n### ghPages([*options*])\n\n*options*: `Object`  \nReturn: [`stream.Transform`](https://nodejs.org/api/stream.html#stream_class_stream_transform)\n\n#### options.remoteUrl\n\nType: `string`  \nDefault: URL for the remote of the current dir (assumes a git repository)\n\nBy default `gulp-gh-pages` assumes the current working directory is a git repository and uses its remote url. If your `gulpfile.js` is not in a git repository, or if you want to push to a different remote url, you can specify it. Ensure you have write access to the repository.\n\n#### options.origin\n\nType: `string`  \nDefault: `\"origin\"`\n\nGit remote.\n\n#### options.branch\n\nType: `string`  \nDefault: `\"gh-pages\"`\n\nThe branch where deploy will by done. Change to \"master\" for `username.github.io` projects.\n\n#### options.cacheDir\n\nType: `string`  \nDefault: `.publish`\n\nSet the directory path to keep a cache of the repository. If it doesn't exist, gulp-gh-pages automatically create it.\n\n#### options.push\n\nType: `boolean`  \nDefault: `true`\n\nAllow you to make a build on the defined branch without pushing it to master. Useful for dry  run.\n\n#### options.force\n\nType: `boolean`  \nDefault: `false`\n\nForce adding files to the `gh-pages` branch, even if they are ignored by `.gitignore` or `.gitignore_global`.\n\n#### options.message\n\nType: `string`  \nDefault: `\"Update [timestamp]\"`\n\nEdit commit message.\n\n## License\n\n[MIT License](./LICENSE) © 2014 [Micheal Benedict](https://github.com/rowoot), 2015 - 2018 [Shinnosuke Watanabe](https://github.com/shinnn)\n","gitHead":"485ddaff1f536f7277b489063a87de41af61a66e","license":"MIT","scripts":{"test":"nyc --reporter=html --reporter=text mocha test.js --timeout 50000 --full-trace","pretest":"eslint ."},"_npmUser":{"name":"shinnn","email":"snnskwtnb@gmail.com"},"homepage":"https://github.com/shinnn/gulp-gh-pages#readme","keywords":["git","push","commit","branch","deploy","deployment","publish","site","website","gulp","gulpplugin","gh-pages","dist","github"],"repository":{"url":"git+https://github.com/shinnn/gulp-gh-pages.git","type":"git"},"_npmVersion":"6.3.0","description":"gulp plugin to publish contents to Github pages","directories":{},"maintainers":[{"name":"rowoot","email":"micheal@visionmasterdesigns.com"},{"name":"shinnn","email":"snnskwtnb@gmail.com"}],"_nodeVersion":"10.8.0","contributors":[{"url":"https://github.com/shinnn","name":"Shinnosuke Watanabe"}],"dependencies":{"gift":"^0.10.2","vinyl":"^2.2.0","rimraf":"^2.6.2","vinyl-fs":"^3.0.3","fancy-log":"^1.3.2","plugin-error":"^1.0.1","inspect-with-kind":"^1.0.4"},"eslintConfig":{"env":{"mocha":true},"rules":{"camelcase":"off","no-underscore-dangle":"off","promise/prefer-await-to-then":"off"},"extends":"@shinnn/node"},"_hasShrinkwrap":false,"readmeFilename":"README.md","devDependencies":{"nyc":"^12.0.2","mocha":"^5.2.0","eslint":"^5.2.0","lodash":"^4.17.10","octonode":"^0.9.3","read-remove-file":"^5.0.1","@shinnn/eslint-config-node":"^6.0.0"},"_npmOperationalInternal":{"tmp":"tmp/gulp-gh-pages_0.6.0-4_1533614599707_0.18917171303353753","host":"s3://npm-registry-packages"},"_id":"gulp-gh-pages@0.6.0-4","version":"0.6.0-4"}