Hugo使用Github Action自动部署到Github Pages

CloudSky

2021-10-14 2021-12-09 约 847 字预计阅读 2 分钟

目的

hugo手动部署到github pages流程:

使用hugo生成静态网页
将静态网页push到建好的github pages repo中，一般是<username>/<username>.github.io

本文的目的就是使用github action自动部署github pages。

流程及原理

本地新建文章，push到Github仓库的master分支。master分支存放博客文章的源码。
push 操作自动触发预先配置的Actions。
GitHub Action自动执行yml文件中的"action"，构建打包，推送至gh-pages repo。

详细步骤

1、首先点击github头像在下拉栏里进入Settings - Developer Settings - Personal access tokens 选择Generate new token

2、填入名字，并勾选repo和workflow选项，如下图

3、在源码repo配置中添加Secret

4、在源码repo里添加如下配置

.github/workflows/gh-pages.yml

name: github pages # 名字自取

on:
  push:
    branches:
      - master  # 这里的意思是当 master 分支发生push的时候，运行下面的jobs

jobs:
  build-deploy: # 任务名自取
    runs-on: ubuntu-latest	# 在什么环境运行任务

    steps:
      - uses: actions/checkout@v2	# 引用actions/checkout这个action，与所在的github仓库同名
        with:
          submodules: true
          fetch-depth: 0

      - name: Setup Hugo	# 步骤名自取
        uses: peaceiris/actions-hugo@v2	# hugo官方提供的action，用于在任务环境中获取hugo
        with:
          hugo-version: 'latest'	# 获取最新版本的hugo

      - name: Build
        run: hugo --minify	# 使用hugo构建静态网页

      - name: Deploy
        uses: peaceiris/actions-gh-pages@v3	# 一个自动发布github pages的action
        with:
          # github_token: ${{ secrets.GITHUB_TOKEN }} 该项适用于发布到源码相同repo的情况，不能用于发布到其他repo
          external_repository: vinsonzou/vinsonzou.github.com	# 发布到哪个repo
          personal_token: ${{ secrets.ACTION_ACCESS_TOKEN }}	# 发布到其他repo需要提供上面生成的personal access token
          cname: ops.m114.org   # 添加你的网站域名作CNAME以便解析
          publish_dir: ./public	# 注意这里指的是要发布哪个文件夹的内容，而不是指发布到目的仓库的什么位置，因为hugo默认生成静态网页到public文件夹，所以这里发布public文件夹里的内容
          publish_branch: master # 发布到哪个branch
          commit_message: ${{ github.event.head_commit.message }}

更新记录

2021-12-09: checkout支持submodules

目录

Hugo使用Github Action自动部署到Github Pages

目的

流程及原理

详细步骤

更新记录