使用 Travis 自动部署 Hexo 到 Github 与 自己的服务器

2

该文写给爱折腾的人,对纯新手不友善,没有辣么详细地说明如何安装node、git或者是hexo,所以关于这些问题可先行google,如有其它问题请在这里或者我的简书上留言

使用hexo而不使用jekyll在github上搭blog最大的问题就是,每次提交都需要先hexo g,然后再push生成的文件们,这样哪怕是改一个小的地方都需要重新编译全部blog,想想都蛋疼(虽然我还没有多少文章),所以决定使用Travis来自动持续集成提交到github以后的操作

网上一搜有很多的教程,看了好多然后东拼西凑才最终成功,遂决定记录下来最终成功的这个方法,以免忘记

本文中实现的最终效果是:

  • 写完blog后,直接push到github的source分支,其它的就可以不用管了

  • 由于我的.travis.yml配置文件里设置监听的就是source分支,所以会触发webhook

  • Travis则会将该项目clone过去,然后按照.travis.yml的设置执行接下来的命令

  • 执行完成后,再将编译好的文件们发送到自己的服务器,顺便pushmaster分支上来

  • 这样就可以在blog.godi13.comGodi13.github.io上都访问blog了

Github

首先,按规定名称XXXXX.github.io,其中XXXXX为你的用户名,如下图中的Godi13.github.io创建项目

创建github项目

为了使travis能够将编译好的文件们push回咱们的github,我们需要生成token,步骤如下:

1) 点击右上方头像,然后点setting

2) 点击Personal access tokens

3) 点击Generate new token

4) 为token起一个名字,勾选repo,然后点击生成

<div class="tip">生成token以后,一定要复制好,因为只显示一次,如果丢失只能再次生成了</div>

Travis

1) 使用github帐号登录Travis,右上方按钮点击同步项目,下方打开需要集成的项目,最后点击齿轮进入项目配置页面

在travis同步

2) 打开Build only if .travis.yml is present,右下角的那个其实也可以关了,然后往下移动页面到环境变量

3) 在这里我将变量名称名为REPO_TOKEN,放上token,点击Add按钮

Terminal

回到终端,进入blog所在的文件夹下,新建.travis.yml文件,并添加以下内容

# 使用语言
language: node_js
# node版本
node_js: stable
# 设置只监听哪个分支
branches:
  only:
  - source
# 缓存,可以节省集成的时间,这里我用了yarn,如果不用可以删除
cache:
  apt: true
  yarn: true
  directories:
    - node_modules
# tarvis生命周期执行顺序详见官网文档
before_install:
- git config --global user.name "Godi13"
- git config --global user.email "mqzq9388@gmail.com"
# 由于使用了yarn,所以需要下载,如不用yarn这两行可以删除
- curl -o- -L https://yarnpkg.com/install.sh | bash
- export PATH=$HOME/.yarn/bin:$PATH
- npm install -g hexo-cli
install:
# 不用yarn的话这里改成 npm i 即可
- yarn
script:
- hexo clean
- hexo generate
after_success:
- cd ./public
- git init
- git add --all .
- git commit -m "Travis CI Auto Builder"
# 这里的 REPO_TOKEN 即之前在 travis 项目的环境变量里添加的
- git push --quiet --force https://$REPO_TOKEN@github.com/Godi13/Godi13.github.io.git
  master

然后,准备push该项目到github,看下是否成功,如果是新项目可参照下面的git指令

git init
# 添加自己的项目
git remote add origin git@github.com:Godi13/Godi13.github.io.git
# 新建并切换分支
git checkout --orphan source
git add -A
git commit -m "Travis CI"
git push

关于 --orphan 请参考 如何建立一個沒有 Parent 的獨立 Git branch

如最终成功则会看到

到这里关于hexo和github的事情就先吿一段落,接下来就是服务器与tarvis

服务器

按照上面.tarvis.yml的设置,其实我只需要在after_success这个生命周期中,把public文件夹下的所有文件传送到服务器指定的路径即可,接下来就是解决如何让tarvis往我的服务器传东西的问题了

在此之前,你需要将本机生成的密钥传到服务器上

ssh-keygen -t rsa # 然后一路回车即可
# ssh-copy-id 可能需要另行安装
# 如果ssh默认端口是22,则不需要 -p
ssh-copy-id <登录部署服务器用户名>@<部署服务器地址> -p <部署服务器ssh端口>
ssh <登录部署服务器用户名>@<部署服务器地址> -p <部署服务器ssh端口>

如果登录服务器成功,接下来需要安装travis命令行工具

# 安装travis命令行工具,如无法使用gem指令须先安装ruby
gem install travis
# --auto自动登录github帐号
travis login --auto
# 此处的--add参数表示自动添加脚本到.travis.yml文件中
travis encrypt-file ~/.ssh/id_rsa --add
# 这个命令会自动把 id_rsa 加密传送到 .git 指定的仓库对应的 travis 中去

执行完以后会发现在travis网站项目里面的环境变量里多了两个参数

并且在.travis.yml里的before_install周期中多了下面这2行

- openssl aes-256-cbc -K $encrypted_97d432d3ed20_key -iv $encrypted_97d432d3ed20_iv
  -in id_rsa.enc -out ~\/.ssh/id_rsa -d

默认生成的命令可能会在/前面带转义符\,我们不需要这些转义符,手动删掉所有的转义符,否则可能在后面引发莫名的错误

之后为了保证命令的顺利运行,我们还需要正确地设置权限和认证

before_install
- openssl aes-256-cbc -K $encrypted_97d432d3ed20_key -iv $encrypted_97d432d3ed20_iv
  -in id_rsa.enc -out ~/.ssh/id_rsa -d
- chmod 600 ~/.ssh/id_rsa
- echo -e "Host 主机IP地址\n\tStrictHostKeyChecking no\n" >> ~/.ssh/config

最后,就是在after_success周期中,添加上传服务器的指令即可,在这里要注意,如果没有stricthostkeychecking=no参数,将构建失败,详细原因请参考通过travis部署代码到远程服务器

# 由于我修改了默认的port,所以在这里也进行了加密处理
- scp -o stricthostkeychecking=no -P $PORT -r public/* 用户@域名:/路径

但使用scp有很多问题,所以后来我决定改用rsync命令,缺点是端口号就不能用travis环境来加密了,如果哪个朋友有更好的方案希望能告诉我

# public 后面加上/即可将该目录下的文件都传送到服务器了
- rsync -rv --delete -e 'ssh -o stricthostkeychecking=no -p 端口号' public/ 用户@域名:/路径

最后在这里放上我最终的.travis.yml配置参数,希望本文对大家能有所帮助,如果觉得不错记得点赞~ 如果能告诉我为什么觉得我写的还不错就更好了,我就知道该怎么再接再厉了,谢谢大家的支持~~~~

参考资料


如果觉得我的文章对你有用,请随意赞赏

你可能感兴趣的

Legolas · 2017年04月14日

知道git hook吗朋友?

回复

0

然后呢?

Godi13 作者 · 2017年04月14日
买一斤辣条 · 4月10日

部署服务器地址 是服务器的ip地址吗?
部署服务器ssh端口 主要是用来干嘛的?

回复

LiWenGu · 11月19日

一直报:The command "yarn install --pure-lockfile" failed and exited with 1 during .
修改成下面的就好了,我怀疑是 npm 的版本问题

# 使用语言
language: node_js

sudo: false

# node版本
node_js:
  - "6"

# 设置只监听哪个分支
branches:
  only:
    - source

# 缓存,可以节省集成的时间,这里我用了yarn,如果不用可以删除
cache:
  yarn: true
  directories:
    - node_modules

# tarvis生命周期执行顺序详见官网文档
before_install:
  - npm install -g hexo-cli

install:
# 不用yarn的话这里改成 npm i 即可
  - yarn install --pure-lockfile

回复

载入中...