用GitLab Runner 自动部署 GitBook 并不难

落日映苍穹つ 2024-03-26 23:19 49阅读 0赞

本文所安装的环境都是在 Linux 下 CentOS 环境下进行的

### 一、安装 node ###

node.js 是使用 GitBook 之前必须要安装的环境

[下载Node官网][Node]

[![alt][]][alt 1]

[![alt][]][alt 1]  [![alt][alt 2]

![alt 2][]][alt_alt 2_ _alt 2]

1.选择 Linux 上 .xz 包下载,.xz 包是已经编译好的。

2.下载完成以后,通过 xftp 方式传输到服务器上中,我传输的路径是在 /usr/local 下。

3. xz -d node-v10.16.2-linux-x64.tar.xz 进行解压得到 node-v10.16.2-linux-x64.tar, 然后使用 tar -xvf node-v10.16.2-linux-x64.tar 再进行解压(对于 .gz 的解压：tar -xzvf node-v10.16.2-linux-x64.tar.gz)

4.解压得到 node-v10.16.2-linux-x64 目录，可以使用 mv node-v10.16.2-linux-x64 nodejs 让 node-v10.16.2-linux-x64 目录变成 nodejs 目录

5.使用 ln -s /usr/local/nodejs/bin/node /usr/bin/node 和 ln -s /usr/local/nodejs/bin/npm /usr/bin/npm 配置到环境变量中

然后在全局执行 node -v 就可以查看 node 的版本了，代表 node 已经安装且配置到全局环境中了！！

### 二、安装 GitBook ###

默认centos7上是没有安装 g++ 通过命令:

yum -y install gcc openssl-devel gcc-c++ compat-gcc-34 compat-gcc-34-c++

使用 npm 方式来安装 GitBook,需要进行第一步的 node 环境安装才可使用 npm..

1.安装 GitBook 环境

npm install -g gitbook

2.使 GitBook 支持命令行

npm install -g gitbook-cli

3.用命令行gitbook看下版本号:

gitbook -V

4.如果找不到命令就建立一个软链接

ln -s /usr/local/nodejs/bin/* /usr/sbin/
    //nodejs 是第一步安装的 node

### 三、安装及使用 GitLab Runner ###

GitLab Runner 依赖 GitLab 环境,需要提前先把 GitLab 先安装好

安装 GitLab 文章：

curl -L https://packages.gitlab.com/install/repositories/runner/gitlab-runner/script.rpm.sh | sudo bash
    yum install gitlab-runner

#### 注册 Runner ####

在使用 Runner 之前需要先注册一个 Runner.先到 GitLab 仓库->CI/CD 下拿到所需要的信息

[![alt][alt 3]][alt_alt 3]

[![alt 3][]][alt_alt 3]  [![alt][alt 4]

![alt 4][]][alt_alt 4_ _alt 4]

一个是 URL 一个是 Token

执行命令：

gitlab-runner register

执行过程如下：

[root@VM-12-201-centos local]# gitlab-runner register
    Running in system-mode.
    
    Please enter the gitlab-ci coordinator URL (e.g. https://gitlab.com/):
    http://119.29.152.1:8090/
    Please enter the gitlab-ci token for this runner:
    yJ3RZjmR5XRAgudYuUnN
    Please enter the gitlab-ci description for this runner:
    [VM-12-201-centos]: install
    Please enter the gitlab-ci tags for this runner (comma separated):
    deploy,build    #需要运行的标签 有 test(测试)/build(构建)/deploy(部署) 三种
    Whether to run untagged builds [true/false]:
    [false]: false
    Whether to lock Runner to current project [true/false]:
    [false]: false
    Registering runner... succeeded runner=yJ3RZjmR
    Please enter the executor: ssh, docker+machine, kubernetes, docker, docker-ssh, parallels, shell, virtualbox, docker-ssh+machine:
    shell
    Runner registered successfully. Feel free to start it, but if it's running already the config should be automatically reloaded!

运行成功以后,就会在刚刚的 CI/CD Runners 下看到刚刚注册的 runner 。

### 四、自动化部署 GitBook ###

在 GitLab 仓库下创建一个 .gitlab-ci.yml 文件,大致内容如下：

build:
        stage: build
        artifacts:
        paths:
         - _book
        script:
         - gitbook init
         - gitbook install
         - gitbook build
        tags:
         - build
    deploy:
        stage: deploy
        script:
         - sudo rm -rf /var/www/book/*
         - sudo cd _book  
         - sudo cp -rf . /var/www/book
         - sudo pwd
         - echo "发布成功!"
        tags:
         - deploy
        only:
         - master

大致意思如下:在 build(构建)时先将 GitBook 所需要的插件和依赖先安装好,并且先构建好到本地的位置,在 deploy(发布)时将要存放文件的地方清空,再 copy 一份 \_book 打包后的文件到指定目录下,通过 Nginx 的方式映射到这个目录即可访问 GitBook 书(**这一步省略**)

然后就是简单的 Git 操作了

###### 创建一个新的仓库 ######

git clone http://localhost:8090/root/article-test.git
    cd article-test
    touch README.md
    git add README.md
    git commit -m "add README"
    git push -u origin master

###### 推送现有文件夹 ######

cd existing_folder
    git init
    git remote add origin http://localhost:8090/root/article-test.git
    git add .
    git commit -m "Initial commit"
    git push -u origin master

###### 推送现有的Git存储库 ######

cd existing_repo
    git remote rename origin old-origin
    git remote add origin http://localhost:8090/root/article-test.git
    git push -u origin --all
    git push -u origin --tags

本地 GitBook 书写好以后,上述操作已经和 Git 仓库绑定在一起了,通过 git add . / git commit -m 'first' / git push origin master 推送上去即可。

### 五、补充-安装 pm2 部署 jar 包程序 ###

以前 spring-mvc 都是通过 Tomcat 进行部署到服务器上的,现在大部分都是采用 SpringBoot 来进行开发的，jar 包方式部署自然成为了一种主流，通过命令行运行 jar 包通常不是在后台运行，pm2 可以帮助我们实现后台部署 jar 包。

1.安装 pm2

npm install pm2 -g \# 需要 node 环境

2.建立软链接

ln -s /usr/local/nodejs/lib/node\_modules/pm2/bin/pm2 /usr/local/bin

如果提示：ln: creating symbolic link \`/usr/local/bin/pm2': File exists

则使用：mv /usr/local/bin/pm2 /tmp/ 删除就好 然后再次执行第一步就OK了

3.pm2 常用命令

pm2 start xxx.jar \#运行

pm2 restart xxx.jar \#重启

pm2 stop xxx.jar \#关闭

pm2 list \#查询正在运行的列表

4.pm2 关于运行 jar 包需要的 json 模板

{
        "name": "anonymous", #jar 的名称
            "script": "/usr/java/default/bin/java", #Java 所在位置，通过 which java 查看
            "args": [
        "-jar",
                "/app/anonymous.jar" #jar 包所在路径位置
    ],
        "exec_interpreter": "",
            "exec_mode": "fork"
    }

#### *相关* ####

[Node]: https://npm.taobao.org/mirrors/node/v10.16.2/
[alt]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/11/9fd9954dc93744a8a1b3ce45b38ca3d9.png
[alt 1]: https://i0.wp.com/www.vnjohn.com/wp-content/uploads/2020/09/node_package.png
[alt 2]: https://i0.wp.com/www.vnjohn.info/wp-content/uploads/2020/09/node_package.png?resize=1920%2C903
[alt_alt 2_ _alt 2]: https://i0.wp.com/www.vnjohn.info/wp-content/uploads/2020/09/node_package.png
[alt 3]: https://i0.wp.com/www.vnjohn.info/wp-content/uploads/2020/09/gitlab-runner.png?resize=1898%2C1777
[alt_alt 3]: https://i0.wp.com/www.vnjohn.info/wp-content/uploads/2020/09/gitlab-runner.png
[alt 4]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/11/5baaa6a8d5b449a6a9cd57c529cd4fa5.png
[alt_alt 4_ _alt 4]: https://i0.wp.com/www.vnjohn.com/wp-content/uploads/2020/09/gitlab-runner.png