GitHub Pages にドキュメントを配置する Wercker step

概要

Hugo のマニュアルによれば，GitHub Pages にドキュメントをプッシュするWercker step には，
lukevivier/gh-pages がある．しかし，この step は過去のコミットを上書きしてしまうため，
コミットログを残す別の step jkawamoto/ghp-import を作った．

使い方

jkawamoto/ghp-import step の実行には，pip が必要です．
wercker.yml の steps に

- install-packages:
    packages: python-pip

を追加するか，box に jkawamoto/ghp-box を使ってください．

jkawamoto/ghp-import step には，次のオプションがあります．

• token: Github のアクセストークン．
• basedie: ドキュメントのルートパス．
• msg: 省略化のコミットメッセージ.
• branch: ブランチ名．デフォルトは gh-pages.

公開リポジトリには public_repo 権限付きのアクセストークン必要です．プライベートリポジトリの場合は，repo 権限が必要になると思います．また，wercker.yml に直接値を書くのではなく環境変数経由で渡してください．環境変数は下記の画面から登録できます．

例

roadie で実際に使用している例は次の通り．

wercker.yml

box: jkawamoto/ghp-box
build:
  steps:
    - script:
        name: Prepare submodules
        code: |-
          git submodule update --init
    - arjen/hugo-build:
        version: "0.15"
        basedir: docs
deploy:
  steps:
    - jkawamoto/ghp-import:
        token: $GIT_TOKEN
        basedir: docs/public