用GitHub Actions自动化部署Hexo博客

以下是用 solitude 主题部署 hexo 的 GitHub Actions 的 yml 文件：

name: Deploy # 部署

on: # 触发条件
  push:
    branches:
      - main # 推送到 main 分支（这里的分支名很重要，不要弄错了

  workflow_dispatch: # 手动触发

jobs:
  build:
    runs-on: ubuntu-latest

    steps:
      - name: 1. 检出仓库 # Checkout
        uses: actions/checkout@v2
        with:
          ref: main

      - name: 2. 安装 Node.js # Setup Node
        uses: actions/setup-node@v3
        with:
          node-version: "16.x"

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

      - name: 4. 缓存 Node 插件 # Cache Modules
        uses: actions/cache@v3
        id: cache-npm
        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 }}-
        #with:
          #path: node_modules
          #key: ${{runner.OS}}-${{hashFiles('**/package-lock.json')}}

#      - name: 安装主题
#        run: |
#          git clone -b main https://github.com/DuoSco/Hexo-theme-solitude.git themes/solitude
#          npm install hexo-renderer-pug hexo-renderer-stylus --save

      - name: 5. 安装依赖 # Install Dependencies 如果没有缓存或 插件有更新，则安装插件
        if: steps.cache-npm.outputs.cache-hit != 'true'
        run: | # **如果仓库里没有 package-lock.json，上传一下，npm ci 必须要有 package-lock.json**
          npm install gulp-cli -g
          npm install --save
          npm install hexo-renderer-pug

      - name: 6. 生成静态文件 # Generate，其中hexo algolia为algolia搜索，hexo gulp为全站压缩，如果没安装则按需删除
        run: |
          hexo clean
          hexo generate
          hexo algolia
          gulp
  
      - name: 7. 部署到 github page # Deploy：github.io仓库中保存每次提交日志 其中clean-exclude为hexo-seo-autopush插件配置，如果没安装则按需删除
        uses: JamesIves/github-pages-deploy-action@v4
        with:
          token: ${{ secrets.GITHUBTOKEN }}
          repository-name: ${{ secrets.GITHUBUSERNAME }}/${{ secrets.GITHUBUSERNAME }}.github.io
          branch: main
          folder: public
          # clean-exclude: |
          #   public/.github/
          commit-message: "${{ github.event.head_commit.message }} updated By Github Actions"

#      - name: 7. 部署到 github page # Deploy：github.io仓库中日志只保留最新
#        run: |
#          cd ./public
#          git init
#          git config --global user.name '${{ secrets.GITHUBUSERNAME }}'
#          git config --global user.email '${{ secrets.GITHUBEMAIL }}'
#          git add .
#          git commit -m "${{ github.event.head_commit.message }} $(date +"%Z %Y-%m-%d %A %H:%M:%S") Updated By Github Actions"
#          git push --force --quiet "https://${{ secrets.GITHUBUSERNAME }}:${{ secrets.GITHUBTOKEN }}@github.com/${{ secrets.GITHUBUSERNAME }}/${{ secrets.GITHUBUSERNAME }}.github.io.git" master:main

  

前置条件：

1. 要新建一个私有仓库 hexo_blog 来存放未解析前的 Hexo 博客文件夹
2. 然后把所有文件拷贝进去
3. GitHub上面申请actions secret：仓库目录下点击Settings->Actions->New repository secret

• 添加三个参数 ：SERVER_PRIVATE_KEY(Github私钥)/GITHUBUSERNAME(Github用户名)/GITHUBEMAIL(Github注册邮箱)
• GitHub私钥（SERVER_PRIVATE_KEY）申请路径：点击账户右上角头像-settings-左下角最下面developer settings-左边点击tokens(classic)-右边generate new token(生成之后期限选择no expiration【不过期】)
  
• 注意这个私钥只能显示一次，一定要备份好，在设置actions secret时候会用到

4. 一定要把 package-lock.json 文件拷贝进去，这个文件是记录依赖安装的，没有的依赖会通过它重新安装
5. 安装依赖的时候出现了 hexo offline 错误提示：
   
   说明：hexo-offline 是 solitude 主题中用于设置 PWA（渐进式 web app）的，不是刚需
   解决方法：删除根目录里面 package.json 中关于 offline 的记录
6. 生成静态文件时出现错误
   解决办法：在根目录建立 gulpfile.js 文件，并写入内容

var gulp = require('gulp');
var cleanCSS = require('gulp-clean-css');
var htmlmin = require('gulp-html-minifier-terser');
var htmlclean = require('gulp-htmlclean');
var terser = require('gulp-terser');
// 压缩js
gulp.task('compress', () =>
gulp.src(['./public/**/*.js', '!./public/**/*.min.js'])
.pipe(terser())
.pipe(gulp.dest('./public'))
)
//压缩css
gulp.task('minify-css', () => {
return gulp.src(['./public/**/*.css'])
.pipe(cleanCSS({
compatibility: 'ie11'
}))
.pipe(gulp.dest('./public'));
});
//压缩html
gulp.task('minify-html', () => {
return gulp.src('./public/**/*.html')
.pipe(htmlclean())
.pipe(htmlmin({
removeComments: true, //清除html注释
collapseWhitespace: true, //压缩html
collapseBooleanAttributes: true,
//省略布尔属性的值，例如：<input checked="true"/> ==> <input />
removeEmptyAttributes: true,
//删除所有空格作属性值，例如：<input id="" /> ==> <input />
removeScriptTypeAttributes: true,
//删除<script>的type="text/javascript"
removeStyleLinkTypeAttributes: true,
//删除<style>和<link>的 type="text/css"
minifyJS: true, //压缩页面 JS
minifyCSS: true, //压缩页面 CSS
minifyURLs: true  //压缩页面URL
}))
.pipe(gulp.dest('./public'))
});

// 运行gulp命令时依次执行以下任务
gulp.task('default', gulp.parallel(
'compress', 'minify-css', 'minify-html'
))

说明：这个插件是用于对代码进行压缩
Reference: 进阶配置 🚀 | Solitude 主题官方文档

改完以上两项之后，autodeploy 成功运行，以后对仓库任何文件的增删改查都会自动部署到 GitHub Pages 中，简直太方便了

Reference: 张时贰-Hexo 博客利用 Github Action 自动化部署