Github Action配合Hexo持续集成博客

Github Action配合Hexo持续集成博客

通过Hexo写博客,根据Hexo文档安装hexo并且找一个自己喜欢的主题,部署在GitPage上,节省我们自己的服务器资源

新建Github仓库

新建github仓库,如hexo-blog ,仓库如果要部署gitpage不能选择private。

新建Hexo目录

hexo init hexo-blog

正常配置hexo和hexo主题并开始写作,写作完成后:

如果你的主题文件夹theme中有.git文件夹,请将其删除后再push代码

git init
git add .
git commit -m "first commit"
git branch -M main
git remote add origin git@github.com:xxxx/hexo-blog (xxx是你的github用户名)git push -u origin main

新建Git Page仓库

在Github中新建一个仓库,仓库名为:

<你的Git用户名>.github.io    //用户名
如: sawyersven.github.io

至此准备工作完成,hexo-blog仓库存放博客的源码,xxx.github.io仓库存放打包生成的静态资源,下边开始配置CI

配置hexo deploy

添加hexo的git deploy依赖:

npm install hexo-deployer-git   / yarn add hexo-deployer-git

在hexo-blog根目录的_config.yml文件中找到deploy字段并添加:

type为git(必须是git)

repo是要发布的repo的地址

...

deploy:
    type: 'git'
    repo: 'git@github.com:<gitusername>/<gitusername>.github.io.git'
...

配置Github Action

GithubAction的文档

配置workflows

hexo-blog项目根目录下创建一个.github\workflows结构的目录,然后新建一个yml文件:

cd path/hexo-blog
mkdir -p .github/workflows
cd ./github/workflows 
touch main.yml

然后我们编辑main.yml:

name: Deploy  #随便取

on:
  push:
      branches:   # 当main或者master分支被push到远端仓库的时候,触发ci
          - main   
          - master
 jobs:
  build:
    runs-on: ubuntu-latest   # 在ubuntu下执行后续的操作

    steps:
      - name: Checkout Respository master branch  #actions/checkout checkout到$GITHUB_WORKSPACE下的repo  默认为当前repo
        uses: actions/checkout@master

      - name: Setup Node.js 14.x # 安装node14
        uses: actions/setup-node@master
        with:
          node-version: '14.17.3'

      - name: Cache node modules  # 缓存依赖增加工作流的执行速度
        uses: actions/cache@v1
        id: cache
        with:
          path: node_modules
          key: ${{ runner.os }}-node-${{ hashFiles('**/[package-lock|yarn.lock].json') }}  # 这里根据用的包管理工具切换lock文件,hashFile会为匹配的文件计算SHA-256哈希值
          restore-keys: |
            ${{runner.os}}-node-
      - name: Setup Hexo Dependencies # 安装hexo-cli 并且安装依赖
        run: |
          npm install hexo-cli -g
          npm install
      - name: Setup Deploy Private Key  # 给ubuntu环境添加ssh的私钥,先按这里填,后边单独讲
        env:
          HEXO_DEPLOY_PRIVATE_KEY: ${{secrets.HEXO_DEPLOY_PRI}}
        run: |
          mkdir -p ~/.ssh/
          echo "$HEXO_DEPLOY_PRIVATE_KEY" > ~/.ssh/id_rsa
          chmod 600 ~/.ssh/id_rsa
          ssh-keyscan github.com >> ~/.ssh/know_hosts
      - name: Setup Git Infomation   # hexo deploy必须有git user.name和git user.email才能运行
        run: |
          git config --global user.name "sawyersven"
          git config --global user.email "kormondor@gmail.com"
      - name: Deploy Hexo
        run: |
          hexo clean
          hexo generate
          hexo deploy
     

配置SSH key

因为是,在hexo-blog的仓库中提交代码然后构建到了xxx.github.io的仓库中,所以需要把SSH key配置在执行action的ubuntu环境中

首先在命令行中执行:

设置filename的时候建议设置为github_id_rsa或者其他名称,以便区分

ssh-keygen   # 生成的key默认在~/.ssh/github_id_rsa,windows在C:/User/<username>/.ssh/github_id_rsa

然后将公钥上传到github的ssh key中:点我直达配置页

选择New SSH key

title : 任意填

key: 用记事本或编辑器打开github_id_rsa.pub,将里面的文本粘贴进去.

配置Action Secrets

由于workflow的文件是在代码仓库中,脚本中的内容是对仓库可见的,如果我们将一些隐私内容直接明文写在文件中,会被泄露。所以github提供了Action secrect来帮我们存放敏感信息。在Actions中通过${{secrets.}}即可获取

进入blog-hexo的repo中,点击settings,然后在侧边栏选择Secrets-Actions

然后选择New repository secret

name中填写HEXO_DEPLOY_PRI

value将github_id_rsa的内容复制后粘贴进去即可

至此github Action的配置就完成了,可以尝试更新hexo-blog的代码并push到github,然后观察Action中job的执行情况.

然后访问xxx.github.io即可查看效果。

这里不建议将本机正在使用的ssh密钥对上传到github中,尤其是私钥.

到这里配置就完成了,后文是一些知识点的补充,可选择阅读

补充阅读

main.yml中的Setup Deploy Private Key

  - name: Setup Deploy Private Key  # 给ubuntu环境添加ssh的私钥,先按这里填,后边单独讲
        env:
          HEXO_DEPLOY_PRIVATE_KEY: ${{secrets.HEXO_DEPLOY_PRI}}  # 设置环境变量
        run: |
          mkdir -p ~/.ssh/    
          echo "$HEXO_DEPLOY_PRIVATE_KEY" > ~/.ssh/id_rsa
          chmod 600 ~/.ssh/id_rsa          ssh-keyscan github.com >> ~/.ssh/know_hosts

拆分理解

mkdir -p ~/.ssh/

创建.ssh文件夹

 echo "$HEXO_DEPLOY_PRIVATE_KEY" > ~/.ssh/id_rsa

读取环境变量$HEXO_DEPLOY_PRIVATE_KEY的值,并将其写入id_rsa中 , 其实这步操作约等于我们在本地生成ssh key并将公钥上传到github的ssh key中,只是顺序对调了而已。

chmod 600 ~/.ssh/id_rsa

设置文件权限为拥有者可读写,其他人不可读写执行

ssh-keyscan github.com >> ~/.ssh/know_hosts

收集github.com的公钥并将其写入know_hosts,避免被openSSH警告

将Gitpage解析到自己的域名

在购买域名的服务商中添加新的CNAME解析,解析值填为:xxx.github.io (你的gitpage的访问地址)

进入gitpage的仓库,并点击settings

在custom domain中填写刚才解析的地址,github会校验域名的解析是否是gitpage,如果是就会successful.

这个时候访问你解析的地址,就可以看到你的Github Page被解析过去了。

CNAME文件

发现每次提交以后设置的Customer domain会被清除掉

所以使用CNAME文件维护

在hexo-blog的source文件夹下创建一个CNAM的文件,内容如下:


blog.sawyersven.xyz  # 只有一行代码,就是你要解析的自定义域名

然后每次deploy后就不用手动调整custom domain了

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

推荐阅读更多精彩内容