使用GitHub Actions自动编译部署hexo博客

前言

为什么要使用GitHub Actions自动编译部署hexo博客？

本博客是如何搭建的

本地部署	GitHub Actions
需手动执行 hexo clean && hexo g -d	代码推送后自动触发编译部署
本地需安装 Node.js/Hexo 环境	云端自动配置纯净构建环境
编译依赖本地电脑性能	利用 GitHub 服务器资源，速度更快
多设备工作需同步环境	任何设备只需 git push 即可更新博客

具体实现方案

1. 两个独立仓库：

   • hexo-source（私有）：存放 Hexo 源码（Markdown 文章、主题、配置文件等）

   • username.github.io（公开）：存放编译后的静态文件（自动通过 GitHub Pages 托管）

     GitHub 规定免费用户的 Pages 服务必须使用公开仓库（私有仓库需 Pro 订阅），该方案可以既保护源码隐私，又符合 Pages 的公开要求

2. 自动化流程：

   • 当向 hexo-source 推送代码时，自动触发 GitHub Actions 完成以下操作：
     1. 安装 Node.js 环境
     2. 编译 Hexo 生成静态文件
     3. 将生成的 public/ 内容推送到 username.github.io 仓库

详细配置步骤

1. 创建SSH密钥对

ssh-keygen -t rsa -b 4096 -f ~/.ssh/hexo_deploy_key

2. 配置密钥

1. 将公钥(hexo_deploy_key.pub)添加到静态网页仓库的Deploy Keys
   • 勾选”Allow write access”
2. 将私钥(hexo_deploy_key)添加到源代码仓库的Secrets
   • 命名为HEXO_DEPLOY_PRIVATE_KEY

3. 配置Hexo

在_config.yml中设置部署目标git静态网页仓库：

deploy:
  type: git
  repo: git@github.com:yourname/yourname.github.io.git
  branch: main

4.创建GitHub Actions工作流

在博客文件目录新建/.github/workflows/deploy.yml

内容示例

name: Deploy hexo site to Pages # 脚本 workflow 名称

on:
  push:
    branches: [main] # 当监测 main分支 的 push
    paths: # 监测所有 source 目录下的文件变动，所有 yml,json 后缀文件的变动。
      - '*.json'
      - '**.yml'
      - '**/source/**'
      - '**/scripts/**'

# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
permissions:
  contents: read
  pages: write
  id-token: write

# Default to bash
defaults:
  run:
    shell: bash

jobs:
  build: # 任务名称
    timeout-minutes: 30 # 设置 30 分钟超时
    runs-on: ubuntu-latest # 指定最新 ubuntu 系统
    steps:
      - uses: actions/checkout@v4
        with:
          token: ${{ secrets.GITHUB_TOKEN }}
          # If your repository depends on submodule, please see: https://github.com/actions/checkout
          submodules: recursive
      - name: Use Node.js 20
        uses: actions/setup-node@v4
        with:
          # Examples: 20, 18.19, >=16.20.2, lts/Iron, lts/Hydrogen, *, latest, current, node
          # Ref: https://github.com/actions/setup-node#supported-version-syntax
          node-version: "20"
      - name: Cache NPM dependencies
        uses: actions/cache@v4
        with:
          path: node_modules
          key: ${{ runner.OS }}-npm-cache
          restore-keys: |
            ${{ runner.OS }}-npm-cache
      - name: Install Dependencies
        run: npm install
      - name: Install Hexo-cli # 安装 Hexo
        run: |
          npm install -g hexo-cli --save
          echo "install hexo successful"
      - name: Build Blog # 编译创建静态博客文件
        run: |
          hexo clean
          hexo generate
          echo "build blog successful"
      - name: Set ssh Permission
        env:
          ACTION_DEPLOY_KEY: ${{ secrets.HEXO_DEPLOY_KEY }}
        run: |
          rm -rf /home/runner/.ssh
          mkdir -p /home/runner/.ssh/
          echo "$ACTION_DEPLOY_KEY" > /home/runner/.ssh/id_rsa
          chmod 700 /home/runner/.ssh
          chmod 600 /home/runner/.ssh/id_rsa
          ssh-keyscan github.com >> /home/runner/.ssh/known_hosts
      - name: Deploy to Github # 设置 git 信息并推送静态博客文件
        run: |
          git config --global user.email "deploy@qq.com"
          git config --global user.name "deploy"
          hexo deploy
      - run: echo "Deploy Successful!"

echo "$ACTION_DEPLOY_KEY" > /home/runner/.ssh/id_rsa实现从secret中读取ssh私钥，从而获取推送到静态网页仓库的权限

参考文章

1. 利用Github Action实现Github到Gitee的持续同步 - SSgeek
2. 使用GitHub Actions自动编译部署hexo博客 - Fungit