使用Jenkins自动发布Gitbook书籍

本文介绍如何使用 jenkins 实现自动化，能够自动监控Github仓库，当有更新时触发根据.md文件生成.html静态网页内容，并发布到Nginx等的Web服务器。

这是【配置GitHub Push自动触发Jenkins构建】的一个特例。下面是以gitbook的项目为例，其他项目只是最后的执行脚本不同。

何以言之

用户需求

公司的一些文档或者个人知识分享，需要比较频繁的发布，希望实现内容从github自动生成gitbook的网页内容，用户只需要关注文档编写和修改，并提交到Git仓库，而不必理会后续一系列繁琐重复的编译发布动作。

解决方案

Github和Gitbook都对文档（博客网站等）的发布提供自动化支持，Github中可以将生成的html page发布github pages上，Gitbook也可以通过设置实现对Github的拉取发布。

但如果想部署到自己的服务器，那需要做一些配置。具体参照以下操作。

何以操之

前置条件

[x] 准备好Jenkins 、Nginx (安装部署见另篇)
[x] 配置Jenkins插件，Git，GitHub的一些相关插件
[x] 在Jenkins所在机器上预装Nodejs和Gitbook
[x] Gitbook项目书籍（文档）放在Github远程仓库中

注：

安装Nodejs是因为Gitbook依赖Nodejs。
为了具有代表性，我们假设Jenkins和Nginx Web服务器单独部署，不在同一台物理机器上（IP地址、DN域名不一样）。

配置GitHub

获取GitHub的Personal access token。

点击左下角的Personal access tokens

点击右上角的Generate new token按钮。

提示输入GitHub密码，输入确定后跳转到创建token的页面

在Token description输入描述，

勾选repo和admin:repo_hook，

点击底部的Generate token按钮，产生一个新的access token。

务必注意：将此字符串复制到记事本备用，后面Jenkins任务中会用到。

关闭这个页面就找不到这个字符串了。

配置Jenkins

登录Jenkins，选择管理Jenkins

点击系统设置

在系统设置页面找到”GitHub”，点击添加GitHub Server

如果没有，返回在插件管理中添加"GitHub"插件。

填写名称，API_URL自动已经默认https://api.github.com（不要修改）

选中管理 Hook，选择Add ->Jenkins

类型选择Secret text，Secret填入上一步骤在GitHub上生成的Personal access tokens，补充描述信息，点击添加完成。

选择刚才的凭据

点击右侧的连接测试按钮，无error则OK。

最后点击页面最底部的Save保存按钮。

查看github仓库地址

github进入自己的项目仓库

选择存放Gitbook的仓库

选择HTTPS，点击右边的复制按钮，粘贴上面我的仓库地址：https://github.com/Robust-Robot/JimBook.git

注意区分，地址栏URL是项目主页：https://github.com/Robust-Robot/JimBook，后面也会用到。

编辑Shell脚本（如果Jenkins和Nginx在同一个服务器）

Bash脚本内容如下，保存为jenkins.sh，存放在git仓库的根目录下：

#!/bin/bash

source /etc/profile

echo "**** env ****"
echo `pwd`
echo `id`
echo "PATH=$PATH"

echo "**** show book list from git ****"
echo `ls -l`
echo

echo "**** for nodejs ****"
npm install
echo "**** build html start ****"
gitbook build
echo "**** build html end ****"
echo "static html content is located in _book folder:"
echo `ls -l _book`

echo "**** remove old document ****"
rm -rf /usr/share/nginx/html/books/jimsbon

echo "**** copy files in _book to nginx ****"
cp -r _book /usr/share/nginx/html/books/jimsbon

echo "**** Bingo! ****"

echo "New book was deployed to nginx:"
echo `ls -l /usr/share/nginx/html/books/jimsbon`