利用 GitHub Actions 实现 hexo 自动部署到远程服务器

桑若木2023-12-032024-03-28

前言

GitHub Actions 是 GitHub 推出的可用于自动化构建，测试和部署项目的平台，可以通过创建工作流来自动化，自定义和执行软件开发工作流程. GitHub Actions 的具体用法有很多，本文仅介绍如何利用它来实现对 Hexo 项目的自动化部署.

准备工作

本地已搭建好 Hexo 项目
创建一个 GitHub 仓库用于存储你的 Hexo 项目源码
创建一个 GitHub 仓库用于存储生成的静态页面文件 (如未主动创建，则Github会将生成的静态文件推送到项目源码的master分支)

代码

name: 自动部署
 # 当有改动推送到master分支时，启动Action
on:
  push:
    branches:
      - main
  release:
    types:
      - published

jobs:
  deploy:
    runs-on: ubuntu-latest
    steps:
      - name: 检查分支
        uses: actions/checkout@v3
        with:
          ref: main

      - name: 安装 Node
        uses: actions/setup-node@v3
        with:
          node-version: "20.x"

      - name: 安装 Hexo
        run: |
          export TZ='Asia/Shanghai'
          npm install hexo-cli -g

      - name: 缓存 Hexo
        id: cache-npm
        uses: actions/cache@v3
        env:
          cache-name: cache-node-modules
        with:
          path: node_modules
          key: ${{ runner.os }}-build-${{ env.cache-name }}-${{ hashFiles('**/package-lock.json') }}
          restore-keys: |
            ${{ runner.os }}-build-${{ env.cache-name }}-
            ${{ runner.os }}-build-
            ${{ runner.os }}-

      - name: 安装依赖
        if: ${{ steps.cache-npm.outputs.cache-hit != 'true' }}
        run: |
          npm install gulp-cli -g #全局安装gulp
          npm install --save
   
      - name: 配置algolia环境变量
        run: |
          export ALGOLIA_ADMIN_API_KEY=…
          export HEXO_ALGOLIA_INDEXING_KEY=…
          
      - name: 生成静态文件
        run: |
          hexo clean
          hexo bangumi -u
          hexo cinema -u
          hexo generate
          hexo algolia
          hexo deploy
          gulp

      - name: 部署到Github
        run: |
          cd ./public
          git init
          git config --global user.name "username"
          git config --global user.email "e-mail"
          git add .
          git commit -m '${{ github.event.head_commit.message }}'
          git push --force --all https://username:github token@github.com/sucooer/sucooer.github.io.git
      - name: 部署到服务器
        uses: burnett01/rsync-deployments@5.2.1
        with:
         switches: -avzh
         path: public/
         remote_path: /root/docker/npm/
         remote_host: 服务器ip
         remote_port: 22
         remote_user: root
         remote_key: ${{ secrets.SERVER_KEY }}

注意:

on push 表示在 push 至该仓库的 main 分支时触发此 workflow, 你可以在 paths-ignore 下添加排除的路径 (即有改动也不触发)
jobs 下的 job 可以自定义名称，但是建议不要有空格，name 则可以自定义任意名称 (可以中文)
step 下的一个分支必须且只能使用 run 和 uses 中的一个
uses 表示使用现有的 GitHub Actions (可以在右侧 Marketplace 搜索)
形如 ${{ secrets.xx }} 的变量为项目的 secret, 均需要在项目中添加,具体位置如下图