在github中通过action自动化部署 hugo academic theme
一、GitHub Action自动化部署Hugo博客方法
主要参考:【Hugo网站搭建】GitHub Action自动化部署Hugo博客
次要参考:使用 Github Action 自动部署 Hugo 博客
二、部署过程中遇到的问题和解决办法
1.在部署过程中遇到如下问题:
bash
Run hugo
hugo: downloading modules ...
hugo: collected modules in 5477 ms
WARN Module "github.com/wowchemy/wowchemy-hugo-themes/modules/wowchemy/v5" is not compatible with this Hugo version; run "hugo mod graph" for more information.
Start building sites ...
hugo v0.114.0-9df2ec7988e5a217a14901cc76c0b7e76b2e9f02 linux/amd64 BuildDate=2023-06-19T17:01:43Z VendorInfo=gohugoio
ERROR render of "page" failed: "/tmp/hugo_cache_runner/modules/filecache/modules/pkg/mod/github.com/wowchemy/wowchemy-hugo-themes/modules/wowchemy/v5@v5.8.1-0.20230812165002-59b648791d3f/layouts/_default/baseof.html:7:3": execute of template failed: template: book/single.html:7:3: executing "book/single.html" at <partial "site_head" .>: error calling partial: "/tmp/hugo_cache_runner/modules/filecache/modules/pkg/mod/github.com/wowchemy/wowchemy-hugo-themes/modules/wowchemy/v5@v5.8.1-0.20230812165002-59b648791d3f/layouts/partials/site_head.html:152:56": execute of template failed: template: partials/site_head.html:152:56: executing "partials/site_head.html" at <resources.Concat>: error calling Concat: resources in Concat must be of the same Media Type, got "text/x-scss" and "text/css"
ERROR TOCSS: failed to transform "main_parsed.scss" (text/x-scss). Check your Hugo installation; you need the extended version to build SCSS/SASS with transpiler set to 'libsass'.: this feature is not available in your current Hugo version, see https://goo.gl/YMrWcn for more information
Total in 5724 ms
Error: error building site: render: failed to render pages: render of "page" failed: "/tmp/hugo_cache_runner/modules/filecache/modules/pkg/mod/github.com/wowchemy/wowchemy-hugo-themes/modules/wowchemy/v5@v5.8.1-0.20230812165002-59b648791d3f/layouts/_default/baseof.html:7:3": execute of template failed: template: _default/single.html:7:3: executing "_default/single.html" at <partial "site_head" .>: error calling partial: "/tmp/hugo_cache_runner/modules/filecache/modules/pkg/mod/github.com/wowchemy/wowchemy-hugo-themes/modules/wowchemy/v5@v5.8.1-0.20230812165002-59b648791d3f/layouts/partials/site_head.html:152:56": execute of template failed: template: partials/site_head.html:152:56: executing "partials/site_head.html" at <resources.Concat>: error calling Concat: resources in Concat must be of the same Media Type, got "text/x-scss" and "text/css"
Error: Process completed with exit code 1.
解决办法:在hugo设置中,使用extended: true即可解决上述问题,答案来源render of "page" failed: execute of template failed: template: event/single.html:5:3: executing "event/single.html" at <partial "site_head" .>: error calling partial #2240:
bash
- name: Setup Hugo
uses: peaceiris/actions-hugo@v2
with:
hugo-version: 'latest'
extended: true
目前autodeploy.yml文件内容如下:
bash
name: Auto Deploy hugo acedemic
on:
push:
branches:
- master # Set a branch to deploy
jobs:
hugo-auto-deploy:
runs-on: ubuntu-latest
steps:
- name: Check out repository code
uses: actions/checkout@v3
with:
submodules: true
fetch-depth: 0
- name: Setup Hugo
uses: peaceiris/actions-hugo@v2
with:
hugo-version: 0.114.0
extended: true
- name: Build
run: hugo --minify
- name: Deploy
uses: peaceiris/actions-gh-pages@v3
with:
deploy_key: ${{ secrets.HUGO_TOKEN }} # secret 中设置好私钥
external_repository: FanfanShen/fanfanshen.github.io # Page 仓库
publish_branch: main # Page 仓库的分支
publish_dir: ./public # 静态网页路径
commit_message: ${{ github.event.head_commit.message }}
2.render of "page"问题已解决,但又出现新问题
bash
Run peaceiris/actions-gh-pages@v3
[INFO] Usage https://github.com/peaceiris/actions-gh-pages#readme
Dump inputs
Setup auth token
[INFO] setup SSH deploy key
/usr/bin/chmod 700 /home/runner/.ssh
[INFO] wrote /home/runner/.ssh/known_hosts
/usr/bin/chmod 600 /home/runner/.ssh/known_hosts
[INFO] wrote /home/runner/.ssh/github
/usr/bin/chmod 600 /home/runner/.ssh/github
[INFO] wrote /home/runner/.ssh/config
/usr/bin/chmod 600 /home/runner/.ssh/config
/usr/bin/ssh-add /home/runner/.ssh/github
Error loading key "/home/runner/.ssh/github": error in libcrypto
Error: Action failed with "The process '/usr/bin/ssh-add' failed with exit code 1"
分析上述问题,主要是ssh验证的问题,发现deploy_key设置问题,查看actions-gh-pages文档的用法即可解决。更新后的部署文件如下:
bash
name: Auto Deploy hugo acedemic
on:
push:
branches:
- main # Set a branch to deploy
jobs:
hugo-auto-deploy:
runs-on: ubuntu-latest
steps:
- name: Check out repository code
uses: actions/checkout@v3
with:
submodules: true
fetch-depth: 0
- name: Setup Hugo
uses: peaceiris/actions-hugo@v2
with:
hugo-version: "latest"
extended: true
- name: Build
run: |
hugo -F --cleanDestinationDir # 生成静态文件
mkdir -p public # 确保public文件夹存在
cp -r public/* ./ # 复制生成的静态文件到仓库根目录
- name: Deploy to GitHub Pages
uses: peaceiris/actions-gh-pages@v3
with:
personal_token: ${{ secrets.HUGO_TOKEN }} # secret 中设置好私钥
external_repository: FanfanShen/fanfanshen.github.io # Page 仓库
publish_branch: master # Page 仓库的分支
publish_dir: ./ # 服务器上生成的静态网页源路径
destination_dir: ./docs
commit_message: ${{ github.event.head_commit.message }}
```
**注意:deploy.yml文件部署在starter-hugo-academic的源代码仓库workflow中,生成的文件会发布到git pages仓库之中,实现代码和发行版分离的效果,发布路径由destination_dir控制输出文件夹。**