使用GitHub Actions自动部署Hexo博客

为了更好地备份我的博客，我将其源码推送到了一个 GitHub 仓库。之前了解过一点 GitHub Actions，遂想着通过这个东西来自动部署博客。

随着博客的内容越来越多，本地编译的速度会越来越慢，况且我还使用了一些 gulp 插件，运行非常耗时，这个时候，把编译、部署的工作交给 GitHub Actions 就是一件非常舒服的事。另一方面，我以前没怎么用过这个功能，正好借此机会熟悉一下 GitHub Actions 的编写。

我的博客之前都是运行在云服务器上，而众所周知，GitHub 提供了免费的静态页面托管服务 ——GitHub Pages。既然我已经把博客迁移到了静态站，那么现在不仅可以选择部署上服务器，还多了一个选择：将博客部署到仓库的 GitHub Pages 下。

设置环境变量

创建一个 SSH 密钥，用于此仓库连接服务器。

bash

ssh-keygen -t rsa -b 4096 -C "git@github.com:windshadow233/windshadow233.github.io.git"

这里，windshadow233.github.io 是我的仓库名。

将此公钥上传到服务器，并将私钥粘贴到仓库的 secrets 下，命名为 SSH_PRIVATE_KEY：

创建变量 SERVER_IP，值为服务器的 ip 地址：

创建 workflow 文件

在仓库根目录创建目录：.github/workflows/，然后在该目录下创建文件：deploy.yml

yaml

name: Deploy Site

on:
  push:
    branches:
      - main
    paths:
      - 'source/**'
      - 'themes/**'
      - '_config.yml'
      - '_config.butterfly.yml'
  workflow_dispatch:

jobs:
  build-and-deploy:
    runs-on: ubuntu-latest
    steps:
    - name: Checkout
      uses: actions/checkout@v4

    - name: Set up Node
      uses: actions/setup-node@v4
      with:
        node-version: '21.7.1'
    - name: Cache Node modules
      uses: actions/cache@v4
      with:
        path: node_modules
        key: ${{ runner.os }}-node-${{ hashFiles('**/package-lock.json') }}
        restore-keys: |
          ${{ runner.os }}-node-

    - name: Install Dependencies
      run: npm install

    - name: Generate Static Files
      run: npm run b

    - name: Set up SSH key
      uses: webfactory/ssh-agent@v0.9.0
      with:
        ssh-private-key: ${{ secrets.SSH_PRIVATE_KEY }}

    - name: Deploy with Rsync
      run: |
        ssh-keyscan -p 22 -H ${{ vars.SERVER_IP }} >> ~/.ssh/known_hosts
        rsync -avz --delete -e "ssh -p 22" ./public/ root@${{ vars.SERVER_IP }}:/var/www/blog/

其中 npm run b 是我定义在 package.json 文件中的命令。上述文件表示在检测到 main 分支的 source/,themes/ 目录以及配置文件的发生变更时，自动触发 GitHub Actions。

需要在 GitHub 中创建一个用于操作 repo 的 token。

创建 workflow 文件

在仓库根目录创建目录：.github/workflows/，然后在该目录下创建文件：deploy.yml

yaml

name: Deploy Site

on:
  push:
    branches:
      - main
    paths:
      - 'source/**'
      - 'themes/**'
      - '_config.yml'
      - '_config.butterfly.yml'
  workflow_dispatch:

jobs:
  build-and-deploy:
    runs-on: ubuntu-latest
    steps:
    - name: Checkout
      uses: actions/checkout@v4

    - name: Set up Node
      uses: actions/setup-node@v4
      with:
        node-version: '21.7.1'
    - name: Cache Node modules
      uses: actions/cache@v4
      with:
        path: node_modules
        key: ${{ runner.os }}-node-${{ hashFiles('**/package-lock.json') }}
        restore-keys: |
          ${{ runner.os }}-node-

    - name: Install Dependencies
      run: npm install

    - name: Generate Static Files
      run: npm run b

    - name: Deploy to gh-pages
      uses: JamesIves/github-pages-deploy-action@v4
      with:
        token: ${{ secrets.GITHUB_TOKEN }}
        branch: gh-pages
        folder: public