2.0.0 • Published 9 years ago

apeman-task-wiki v2.0.0

Weekly downloads
2
License
MIT
Repository
github
Last release
9 years ago

apeman-task-wiki

Build Status Code Climate Code Coverage npm Version JS Standard

apeman task to push github wiki.

Running this task cause:

  1. Clone GitHub wiki project into temporary directory.
  2. Copy files from main repo in to the cloned wiki repo.
  3. Commit and push the cloned wiki repo.
  4. Cleanup the cloned wiki repo.

Installation

$ npm install apeman-task-wiki --save-dev

Usage

  1. Define a task within Apemanfile.js
  2. 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
NameTypeDefaultDescription
srcstringSource file name pattern.
optionsobjectOptional settings.
options.msgstringMessage for commit.
options.tmpstringTmp directory path.
options.urlstringWiki url. Auto detect unless specified.

License

This software is released under the MIT License.

Links

2.0.0

9 years ago

1.0.4

9 years ago

1.0.3

10 years ago

1.0.2

10 years ago

1.0.1

10 years ago

1.0.0

10 years ago