README
apeman-task-wiki
apeman task to push github wiki.
Running this task cause:
- Clone GitHub wiki project into temporary directory.
- Copy files from main repo in to the cloned wiki repo.
- Commit and push the cloned wiki repo.
- Cleanup the cloned wiki repo.
Installation
$ npm install apeman-task-wiki --save-dev
Usage
- Define a task within Apemanfile.js
- Call the task via apeman task command.
Apemanfile.js
/** This is an example Apemanfile to use apeman-task-wiki */
'use strict'
module.exports = {
$pkg: { /* ... */ },
$tasks: {
// Define your own task.
'wiki:push': require('apeman-task-wiki')('./doc/wiki', {
//Options
})
}
}
Then,
$ apeman task wiki:push
Signature
define(src, options) -> function
apeman task to push github wiki.
Args
Name | Type | Default | Description |
---|---|---|---|
src | string | Source file name pattern. | |
options | object | Optional settings. | |
options.msg | string | Message for commit. | |
options.tmp | string | Tmp directory path. | |
options.url | string | Wiki url. Auto detect unless specified. |
License
This software is released under the MIT License.