Hugo博客自动部署

1. 准备工作

#

1.1 新建GitHub仓库

#

新建仓库名称为username.github.io格式，并选择默认的Public。

1.2 购买域名

#

在Cloudflare注册账号，选择注册域名，搜索想注册的域名然后购买完成注册。

1.3 域名托管

#

选择Websites里面的域名进入域名管理页面，添加DNS记录，选择CNAME，添加子域名www，指向GitHub Pages地址。

2. GitHub Pages托管

#

2.1 修改本地配置

#

修改本地站点配置quickstart/config.toml，将baseURL改为自己的域名。

baseURL = 'https://www.regina23.com/'
languageCode = 'zh-cn'
title = "Regina23's Blog"
theme = "LoveIt"

2.2 本地仓库关联到远程仓库

#

Hugo 默认将生成的静态网页文件存放在 qiuckstart/public/ 目录下，将该目录初始化，并关联到远程仓库。

cd qiuckstart/public
git init 
git remote add origin [email protected]:regina23/regina23.github.io.git

本地构建并检查文章内容，无误后推送到远程仓库。

cd qiuckstart
hugo
hugo server

git add .
git commit -m "add pages"
git push origin master

2.2 远程仓库设置域名

#

进入1.1新建的GitHub仓库，在Settings -> Pages确认部署的分支并保存，然后配置自定义域名并保存。

此时，打开域名网址可以看到博客以及部署上去了。

3. GitHub Actions自动发布

#

3.1 新建远程仓库和Hugo根目录关联

#

GitHubPages托管+手动发布静态文件比较繁琐，因此选择GitHub Action进行自动化发布。

新建仓库，例如regina23.github.io.source，将本地Hugo根目录qiuckstart关联到该仓库并推送。

cd qiuckstart
git init 
git remote add origin [email protected]:regina23/regina23.github.io.source.git
git add .
git commit -m "init"
git push origin master

3.2 配置GitHub Actions

#

在远程仓库新建GitHub Actions->Hugo，会在目录/.github/workflows/下，以.yml为后缀新建配置文件。

本质是根目录更新时同时推送到GitHub Pages仓库，所以需要修改外部仓库地址为EXTERNAL_REPOSITORY: regina23/regina23.github.io，对应根目录的./public目录。  

name: deploy

on:
    push: 
    workflow_dispatch:

jobs:
    build:
        runs-on: ubuntu-latest
        steps:
            - name: Checkout
              uses: actions/checkout@v3
              with:
                  submodules: true
                  fetch-depth: 0

            - name: Setup Hugo
              uses: peaceiris/actions-hugo@v2
              with:
                  hugo-version: "0.105.0"
                  extended: true

            - name: Build Web
              run: hugo --minify

            - name: Deploy Web
              uses: peaceiris/actions-gh-pages@v3
              with:
                  PERSONAL_TOKEN: ${{ secrets.PERSONAL_TOKEN }}
                  EXTERNAL_REPOSITORY: regina23/regina23.github.io
                  PUBLISH_BRANCH: master
                  PUBLISH_DIR: ./public
                  commit_message: ${{ github.event.head_commit.message }}

此外，从博客仓库推送到外部 GitHub Pages 仓库，需要特定权限，在GitHub账户下Settings->Developer settings->Personal access tokens (classic)，新建token，权限选择repo和workflow。

复制生成的TOKEN，在博客源仓库Settings->Secrets->Actions新建名称为PERSONAL_TOKEN内容为TOKEN的变量。

3.3 测试

#

完成后，本地根目录推送到远程源代码仓库，即可触发GitHub Actions，自动生成Hugo博客页面并推送到GitHub Pages仓库，然后部署发布到网站。

如果出现报错：No url found for submodule path '.public'

#

需要将public模块和根目录关联，在qiuckstart/.gitmodules添加：

[submodule "public"]
    path = public
    url = https://github.com/regina23/regina23.github.io.git