我们搭建个人博客的初衷,不就是为了能好好地写文章吗?一切重复且枯燥的工作都应该交给程序去自动完成,尤其是静态博客编译和部署,我们只需要专注文字。
什么是 GitHub Actions
GitHub Actions 是 GitHub 的持续集成服务。持续集成由很多操作组成,比如抓取代码、运行测试、登录远程服务器,发布到第三方服务等等。GitHub 把这些操作就称为 actions。
很多操作在不同项目里面是类似的,完全可以共享。GitHub 允许开发者把每个操作写成独立的脚本文件,存放到代码仓库,使得其他开发者可以引用。
如果你需要某个 action,不必自己写复杂的脚本,直接引用他人写好的 action 即可,整个持续集成过程,就变成了一个 actions 的组合。这就是 GitHub Actions 最特别的地方。
本例就使用由 theme-keep 提供的
action
hexo-deploy-github-pages-action 来自动部署 Hexo。
使用 GitHub Actions 自动部署的好处
- 可以直接在线编辑
md
文件,立即生效。假设你已发布一篇文章,过几天你在别的电脑上浏览发现有几个明显的错别字,这是完全不能容忍的。但此时你电脑上又没有hexo + node.js + git
等完整的开发环境,重新配置开发环境明显不现实。如果使用 CI,你可以直接用浏览器访问 GitHub 上的项目仓库,直接编辑带错别字的md
文章,改完,在线提交,稍等片刻,你的网站就自动更新了。 - 如果手动部署,需要先执行
hexo g
编译生成静态文件, 然后推送public
整个文件夹到 GitHub 上,当后期网站文章、图片较多时候,很多时候连接 GitHub 不是那么顺畅,经常要傻等很长的上传时间。使用 GitHub Actions 自动部署,你只需push
_post 文件里单独的md
文件即可,其他不用管,效率瞬间高了许多,其中的好处,谁用谁知道。 - 使用 GitHub Actions,你还可以一次性将这些静态博客页面部署到多个服务器上,例如:GitHub Pages、Gitee pages、七牛云、阿里云、腾讯云等等。
- …
准备工作
本文以 Hexo + Keep 主题搭建博客为例,教你如何使用 GitHub Actions 将博客自动部署到 GitHub Pages。
创建 GitHub 仓库
创建两个 GitHub 仓库,一个公共仓库和一个私有仓库。
私有仓库用来存储 Hexo 项目源代码。(保证你的重要信息不泄露)
公共仓库用来存储编译之后的静态页面。
本例:
- 用私有仓库的
master
分支来存储项目源代码。 - 用公共仓库的
gh-pages 分支
来存储静态页面。
当私有仓库的 master
有内容 push
进来时(例如:主题文件,文章 md 文件、图片等), 会触发 GitHub Actions 自动编译并部署到公共仓库的 gh-pages 分支
。
创建 GitHub Token
创建一个有 repo 和 workflow 权限的 GitHub Token 。
新生成的 Token 只会显示一次,如有遗失,重新生成即可。
创建 repository secret
将上面生成的 Token 添加到私有仓库的 Secrets
里,并将这个新增的 secret
命名为 HEXO_DEPLOY
(名字无所谓,看你喜欢)。
步骤:私有仓库 -> settings
-> Secrets
-> New repository secret
。
新创建的 secret
HEXO_DEPLOY
在 Actions 配置文件要用到,需跟配置文件保持一致!
添加 Actions 配置文件
- 在你的 Hexo 项目根目录下创建
.github
文件夹。 - 在
.github
文件夹下创建workflows
文件夹。 - 在
workflows
文件夹下创建hexo-deploy.yml
文件。
hexo-deploy.yml
文件的内容如下:
1 | name: deploying Hexo project to GitHub pages |
在上面的配置文件中,使用了 theme-keep 组织封装的 hexo-deploy-github-pages-action ,是一款专门部署 Hexo 博客到 GitHub pages 的 action,欢迎大家 Star 和 Fork
至此,准备工作完毕~
自动部署触发流程
修改你的 Hexo 博客源代码(例如:增加文章、修改文章、更改主题、修改主题配置文件等等)。
把你修改过的 Hexo 项目内容(只提交修改过的那部分内容)
push
到 GitHub 私有仓库(本例:keep-site-source)的master
分支。GitHub Actions 检测到
master
分支有内容push
进来,会自动执行 action 配置文件的命令,将 Hexo 项目编译成静态页面,然后部署到公共仓库的gh-pages
分支。gh-pages
分支是 GitHub Pages 服务的固定分支,你只需在hexo-deploy.yml
文件正确填写,会自动创建。在私有仓库的 Actions 可以查看到你配置的 action。
通过 GitHub Actions 自动部署成功的效果图:
类似工具
除了 GitHub Actions,我们还可以使用 Travis CI 来实现 Hexo 自动部署,效果是一样的,任君选择。
教程:使用 Travis CI 自动部署 Hexo 静态博客
作者:XPoet
链接:https://juejin.cn/post/6943895271751286821
来源:稀土掘金
著作权归作者所有。商业转载请联系作者获得授权,非商业转载请注明出处。