通过Github Action自动部署Hugo

以前过hexo 和 dukewiki 做过个人学习笔记和Blog,但是部署在树莓派上。因为该死的switch,对,就是玩游戏的那个。当时switch有SD不够用,就把树莓派上的SD卡拿来格式化了(忘记wiki部署在上面),结果所有的笔记全部没有了。这是一个悲惨的教训,所以有了接下来的事情,废话不多说了,直接开始。

先说说我的需求

1.Blog的内容不会丢失。(利用Github进行托管)

2.运行在自己的服务器上。(为什么要这个呢,因为Github经常被墙或者打不开,总之速度得不到保证)

3.需要支持Markdown。(出于程序员的习惯)

4.编辑Markdown以后能实时更新到Blog上。(我希望随时随地能编辑自己的文章)

根据上面的需求,我想到的办法就是利用Github Action 进行自动部署,然后通过Hugo 将Markdown生成成为静态页面。

注意:我们有一个前提条件,你需要有一台自己的VPS

在Github上创建一个仓库

这个不用教了,太简单,反正第一件事情就是先把这个仓库建好。

Hugo的使用

安装Hugo

第一步就是在自己的VPS上安装Hugo,安装Hugo的方式有很多,如果是ubuntu系统执行下面命令就可以安装。

sudo apt install hugo

不过系统自带软件源中的hugo版本不一定是最新的,可以通过官方Release下载自己对应的最新版本。

https://github.com/gohugoio/hugo/releases

部分主题生成HTML,需要Sass/SCSS支持,这个时候要安装hugo_extended包,否则安装hugo包就好了。

安装Hugo

wget https://github.com/gohugoio/hugo/releases/download/v0.76.5/hugo_0.76.5_Linux-64bit.deb
dpkg -i hugo_0.76.5_Linux-64bit.deb

安装Hugo Extended

wget https://github.com/gohugoio/hugo/releases/download/v0.76.5/hugo_extended_0.76.5_Linux-64bit.deb
dpkg -i hugo_extended_0.76.5_Linux-64bit.deb

利用Hugo创建一个自己的站点

执行命令,最后一个参数是站点的名称,这里就直接叫blog

hugo new site blog

创建好以后可以进入到目录下,可以看到下面这些目录

$ cd blog
$ ls
archetypes  config.toml  content  data  layouts  static  themes

将blog变成一个git项目

git init

选择hugo主题

我们用docsy 作为主题,其它主题可以到Hugo的官网自己下载。执行下面命令通过submodule命令将主题作为仓库的子模块。

git submodule add https://github.com/google/docsy.git themes/docsy
git submodule update --init --recursive

先使用主题默认的配置作为站点配置,关于详细的配置可以到主题自行去研究。

cp themes/docsy/userguide .

运行Hugo

执行下面命令就能运行hugo了。

hugo server -D

会看到以下信息,表示运行成功。

Start building sites … 

                   | ZH  
-------------------+-----
  Pages            | 44  
  Paginator pages  |  0  
  Non-page files   |  2  
  Static files     | 38  
  Processed images |  3  
  Aliases          |  1  
  Sitemaps         |  1  
  Cleaned          |  0  

Built in 310 ms
Watching for changes in /home/micro/blog
archetypes,assets,content,layouts,package.json,themes}
Watching for config changes in  /home/micro/blog/config.toml,  /home/micro/blog/themes/docsy/config.toml
Environment: "development"
Serving pages from memory
Running in Fast Render Mode. For full rebuilds on change: hugo server --disableFastRender
Web Server is available at //localhost:1313/ (bind address 127.0.0.1)

打开浏览器访问 http://localhost:1313 可以看到自己的网站了。

最后将代码提交到Github仓库中。

Github CI/CD

Github CI/CD 可以通过 Gitlhub Action来完成。

安装Github Runner

打开自己的Github上的项目,在项目的Settings->Actions中,拖到页面的最后面,有一项Self-hosted runners,我们在这里点击Add runner按钮。会跳转到Github Runner的安装页面,页面上有相关的安装教程。

然后我们下载安装,并且在自己的服务器上将这个程序运行起来。Github Runner配置的时候需要指定一个token通过这个token就能将它和自己的项目绑定在一起了。

配置Action Workflow

配置好Runer以后需要我们在自己的项目中配置工作流,比如我们想配置在提交代码以后让Gitlhub Action触发我们服务器上的Github Runner获取最新的代码,并执行Hugo的发布过程。

在项目的.github目录下创建一个hugo.yml文件。

mkdir .github
touch hugo.yml

hugo.yml的内容如下

name: hugo

on:
  push:
    branches: [ master ]
  pull_request:
    branches: [ master ]

jobs:
  build:
    runs-on: self-hosted
    steps:
      - uses: actions/checkout@v2 #获取最新代码
        with:
          submodules: recursive
      - name: npm install
        run: |
          # Install npm dependencies
          npm install
      - name: Build HTML #生成HTML代码
        run: |
          rm -rf public/
          HUGO_ENV="production" hugo --gc || exit 1 

上面是Github Action的配置,表示当在master分支提交代码的时候,触发self-hosted主机,也就是我们自己的服务执行setps里面的命令。其中npm installdocsy主题特有的。

这里有一个地方需要特别注意:通过actions/checkout@v2获取代码需要将服务的sshkey配置到Github仓库的对应的Deploy Keys中。否则它会通过Github Rest Api获取代码,获取的代码不是git项目,无法进行submodule 的操作。

添加Deploy Keys 在项目的Settings->Deploy Keys进行。

完成上面操作以后,提交代码可以在项目的Actions中查看工作流,确保没有问题。

当工作流执行成功,我们可以在Gitlab Runner的安装目录下看到_work/blog/blog/public目录,这里就是生成的html代码。

最后利用Nginx作为http服务器,就能访问网站了,同时所有更新提交的文档都能实时部署到网站上。

我的个人博客

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 203,772评论 6 477
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 85,458评论 2 381
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 150,610评论 0 337
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 54,640评论 1 276
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 63,657评论 5 365
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 48,590评论 1 281
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 37,962评论 3 395
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 36,631评论 0 258
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 40,870评论 1 297
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,611评论 2 321
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 37,704评论 1 329
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,386评论 4 319
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 38,969评论 3 307
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 29,944评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,179评论 1 260
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 44,742评论 2 349
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 42,440评论 2 342