使用hugo框架+github action创建个人博客
使用hugo框架+github action创建个人博客
本操作是使用静态页面后的进阶操作,主要是为了省去在本地进行hugo编译的步骤。理想的状态是,我只负责写文,和将好的md提交到git备份,然后就可以坐等网站内容更新了,官方提供的GitHub Action正可以满足这个需求。
需要管理两个仓库,一个是原先的静态仓库,一个是整个hugo仓库
Github Action需要做两件事:
- 编译,生成静态文件
- 部署,把静态文件移动到合适的位置
主要流程
- 配置私有hugo库的Github Action
- 配置合适的token
在hugo博客根目录下,创建放置Github Action
配置文件
的目录 .github/workflows
;在 .github/workflows
目录下,创建一个
yml文件
,这就是Github Action需要的一个工作流的配置,如果需要多个工作流可以创建多个yml文件
博主.yml文件示例
|
|
配置合适的token
首先,需要生成一个Personal access tokens
- 在个人GitHub页面,依次点击(个人设置)
Settings
->Developer settings
->Personal access tokens
进入如下页面:
- 点击
Generate new token
出现如下界面,在Note中输入名称,在Select scopes选择workflow
将生成的token复制出来为后续创建
secret
做准备,注意必须及时复制,一旦离开此页面后续就无法查看其值,只能重新创建新token。进入对应的
GitHub
项目下,依次点击Settings
->Secrets
->Actions
进入添加Action secrets
的界面,点击New repository secret
按钮
- 在出现的界面中name部分输入在yml中设置的值,
Secret
部分输入步骤3中记录的token值,然后点击Add secret
按钮
![需要注意的是name
的值不能以GITHUB_
开头,否则创建会出错
- 在流水线中将
personal_token
值设置为步骤5中secret
的名称,类似${{ secrets.PERSONAL_TOKEN }}s
,至此personal_token
设置过程完毕。
在这里需要特别说明一下, hugo官网的例子用的是github_token,然而实操时才发现github_token不支持外部库,我们采用的两个仓库的方案不能使用github_token。 Github Action除了github_token之外,还支持deploy_token和personal_token。出于方便考虑,我选择了personal_token。
至此整个设置过程完毕!
结论
完成上述配置后,当我们完成一篇md文章后,用git命令push到远程仓库时,即可触发GitHub Action,按工作流的配置自动生成静态页面文件,并推送到GitHub Pages仓库。而 GitHub Pages 仓库更新后,又会自动触发官方页面部署 CI,实现网站的自动发布。
到此,我们已经实现了 Hugo 博客本地搭建及版本管理、GitHub Pages 自动部署网站发布,实现了完整的自动发布系统。现在每当我完成内容编辑后,只需要推送代码,等待几分钟,即可通过我们的自定义域名访问更新后的网站。