Simiki + Travis-ci + Github-Pages 搭建自动部署的个人 Wiki

一些零散的知识记到博客上太零碎,自己本地记录的也不够系统,决定折腾折腾 wiki。

为什么选择 Simiki,此处不展开,这里说说如何结合 Simiki 和 Travis-ci 自动部署 wiki-Web。要达到的效果是:本地 wiki 写好,一条命令 fab commit,网页端 wiki 就好了。

各种依赖

大致步骤

详细说明

创建自己的 github page 项目

此处略,你可以参考官方文档。我这里绑定了自定义域名,所以域名是 http://wiki.zvv.im/

github 项目在 travis-ci 中开启自动部署

代码库中增加 .travis 文件,包含环境、授权、部署命令

这里再略就不用写什么了 ;)

注:我这里 md 文件在 wiki 分支,部署是到 master 分支

环境

新增 .travis.yml 文件,加入如下内容:

language: python
python:
- '2.7'

install:
- pip install fabric
- pip install ghp-import
- pip install simiki

branches:
  only:
  - wiki

把环境依赖装好,设定持续继承只处理 wiki 分支的提交

授权

这块比较复杂,travis 需要在虚拟机中 push 你的代码到 github,所以需要类似本地的 ssh-key 授权。

项目设置中需要增加 deploy key https://github.com/zvving/zvving.github.io/settings/keys

这里我主要参考了 用 Travis CI 自動部署網站到 GitHub | Zespia 这篇文章。大家看这个吧,够细致。

gem install travis
travis login --auto
travis encrypt-file ~/.ssh/id_rsa_bot --add

部署命令

部署命令本身并不复杂,只有

script:
- simiki g
- fab deploy

不过 fab deploy 中碰到两个问题

问题1:
  • Q:
**0.22s**
**$ fab deploy**
**[localhost] local: which -s ghp-import; echo $?**
**Traceback (most recent call last):**
**  File "/home/travis/virtualenv/python2.7.9/lib/python2.7/site-packages/fabric/main.py", line 743, in main**
**    *args, **kwargs**
**  File "/home/travis/virtualenv/python2.7.9/lib/python2.7/site-packages/fabric/tasks.py", line 427, in execute**
**    results['<local-only>'] = task.run(*args, **new_kwargs)**
**  File "/home/travis/virtualenv/python2.7.9/lib/python2.7/site-packages/fabric/tasks.py", line 174, in run**
**    return self.wrapped(*args, **kwargs)**
**  File "/home/travis/build/zvving/zvving.****github.io/fabfile.py****", line 145, in deploy**
**    func(deploy_item)**
**  File "/home/travis/build/zvving/zvving.****github.io/fabfile.py****", line 72, in deploy_git**
**    if int(res.strip()):**
**ValueError: invalid literal for int() with base 10: 'Usage: /usr/bin/which [-a] args\n2'**
  • A: travis 上是 ubuntu 在部署,which 命令没有 -s 参数,所以要把 fabric.py:71 改成 res = local('which -a ghp-import > /dev/null; echo $?', capture=True)
问题2:
  • Q: 我用 ghp-import 一直碰到 rejected,没有找到具体原因
0.57s$ fab deploy
[localhost] local: which -a ghp-import > /dev/null; echo $?
[localhost] local: git fetch
[localhost] local: ghp-import -p -m "Update output documentation" -r git@github.com:zvving/zvving.github.io.git -b master output
Warning: Permanently added the RSA host key for IP address '192.30.252.131' to the list of known hosts.
To git@github.com:zvving/zvving.github.io.git
 ! [rejected]        master -> master (fetch first)
error: failed to push some refs to 'git@github.com:zvving/zvving.github.io.git'
hint: Updates were rejected because the remote contains work that you do
hint: not have locally. This is usually caused by another repository pushing
hint: to the same ref. You may want to first integrate the remote changes
hint: (e.g., 'git pull ...') before pushing again.
hint: See the 'Note about fast-forwards' in 'git push --help' for details.
Traceback (most recent call last):
  File "/home/travis/virtualenv/python2.7.9/bin/ghp-import", line 198, in <module>
    main()
  File "/home/travis/virtualenv/python2.7.9/bin/ghp-import", line 194, in main
    sp.check_call(['git', 'push', opts.remote, opts.branch])
  File "/opt/python/2.7.9/lib/python2.7/subprocess.py", line 540, in check_call
    raise CalledProcessError(retcode, cmd)
subprocess.CalledProcessError: Command '['git', 'push', 'git@github.com:zvving/zvving.github.io.git', 'master']' returned non-zero exit status 1
Fatal error: local() encountered an error (return code 1) while executing 'ghp-import -p -m "Update output documentation" -r git@github.com:zvving/zvving.github.io.git -b master output'
  • A: 迫不得已,只能先不用 ghp-import,自己写部署命令。具体也不复杂,把这两行
local('ghp-import -p -m "{0}" -r {1} -b {2} {3}' \
      .format(_mesg, remote, branch, output_dir))

改成

local('git fetch')
local('git checkout -b ' + branch)
local('cp -rf output/* ./')
local('rm -rf output')
local('git add -A && git commit -am "test"')
local('git push -f --repo git@github.com:zvving/zvving.github.io.git')
local('git checkout wiki')

具体参见这里ghp-import 也没有 --force 参数,如果你知道好的解法请一定告诉我。

这两个问题花了我不少时间,麻烦留言告知我你是否碰到一样的问题。确认问题了再给作者发 PR。

上最终版本

language: python
python:
- '2.7'
before_install:
- openssl aes-256-cbc -K $encrypted_3db71d9c9ac7_key -iv $encrypted_3db71d9c9ac7_iv
  -in .travis/id_rsa_bot.enc -out ~/.ssh/id_rsa -d
- chmod 600 ~/.ssh/id_rsa
- eval $(ssh-agent)
- ssh-add ~/.ssh/id_rsa
- cp .travis/ssh_config ~/.ssh/config
- git config --global user.name "zvving-bot"
- git config --global user.email "zvving+bot@gmail.com"
- git config --global push.default simple
install:
- pip install fabric
- pip install ghp-import
- pip install simiki
before_script:

script:
# try travis-ci 12
- simiki g
- fab deploy
branches:
  only:
  - wiki

也可以参见这里

一些问题

总结

  • 如果你愿意的话,可以不把 wiki 分支签到本地书写再 commit&push,直接在 github 网页端编辑文件,wiki-web 就自动更新了
  • 部署坑不少,作为 Python 新手走了些弯路,浪费了不少时间
最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 117,141评论 1 238
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 50,745评论 1 200
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 72,150评论 0 164
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 35,434评论 0 126
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 42,207评论 1 204
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 35,013评论 1 124
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 26,985评论 2 206
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 26,138评论 0 119
  • 想象着我的养父在大火中拼命挣扎,窒息,最后皮肤化为焦炭。我心中就已经是抑制不住地欢快,这就叫做以其人之道,还治其人...
    爱写小说的胖达阅读 25,089评论 5 169
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 29,163评论 0 177
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 26,399评论 1 167
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 27,631评论 1 173
  • 白月光回国,霸总把我这个替身辞退。还一脸阴沉的警告我。[不要出现在思思面前, 不然我有一百种方法让你生不如死。]我...
    爱写小说的胖达阅读 21,988评论 0 24
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 24,594评论 2 163
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 28,406评论 3 171
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 23,377评论 0 4
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 23,495评论 0 112
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 29,594评论 2 187
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 30,021评论 2 187

推荐阅读更多精彩内容