github/gh-pages
1
0
Fork 0
mirror of https://github.com/rschamp/gh-pages.git synced 2025-11-04 12:51:11 +08:00
Code Issues Projects Releases Wiki Activity

Document the remote option

Browse Source
This commit is contained in:
Tim Schaub 2016-03-02 08:40:48 -07:00
parent dfbdfe08f3
commit ce5368f8a1
2 changed files with 21 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
bin/gh-pages
View File

@ -15,6 +15,8 @@ program
.option('-x, --silent', 'Do not output the repository url') .option('-x, --silent', 'Do not output the repository url')
.option('-b, --branch <branch>', .option('-b, --branch <branch>',
'name of the branch you\'ll be pushing to', 'gh-pages') 'name of the branch you\'ll be pushing to', 'gh-pages')
.option('-o, --remote <name>',
'The name of the remote', 'origin')
.option('-m, --message <message>', .option('-m, --message <message>',
'commit message', 'Updates') 'commit message', 'Updates')
.option('-t, --dotfiles', 'Include dotfiles') .option('-t, --dotfiles', 'Include dotfiles')
@ -30,6 +32,7 @@ ghpages.publish(path.join(process.cwd(), program.dist), {
message: program.message, message: program.message,
dotfiles: !!program.dotfiles, dotfiles: !!program.dotfiles,
add: !!program.add, add: !!program.add,
remote: program.remote,
push: !program.noPush, push: !program.noPush,
logger: function(message) { logger: function(message) {
process.stderr.write(message + '\n'); process.stderr.write(message + '\n');

18
readme.md
View File

@ -149,6 +149,24 @@ ghpages.publish(path.join(__dirname, 'build'), {
``` ```
#### <a id="optionsremote">options.remote</a>
* type: `string`
* default: `'origin'`
The name of the remote you'll be pushing to. The default is your `'origin'` remote, but this can be configured to push to any remote.
Example use of the `remote` option:
```js
/**
* This task pushes to the `gh-pages` branch of of your `upstream` remote.
*/
ghpages.publish(path.join(__dirname, 'build'), {
remote: 'upstream'
}, callback);
```
#### <a id="optionstag">options.tag</a> #### <a id="optionstag">options.tag</a>
* type: `string` * type: `string`
* default: `''` * default: `''`