使用Github Action实现全自动部署

Github Action简介

Github Action是 GitHub于2018年10月推出的一个CI\CD服务。

CI/CD解释

CI\CD 其实说的是三件事情：「持续集成（Continuous Integration）」、「持续交付（Continuous Delivery）」、「持续部署（Continuous Deployment）」。
因为「持续交付」和「持续部署」的英文缩写是一样的，所以这三件事情缩写成了 CI\CD 。

每次部署Hexo都需要运行指令三件套，随着文章越来越多，编译的时间也随之越来越长，通过Github Action，我们只需要在每次完成博客的编写或修改以后，将改动直接push到远程仓库，之后的编译部署的工作统统交给CI来完成即可，如果是看过Coding部署教程的小伙伴，应该对这种持续部署的操作有所感触。

教程常量声明

感谢@YML的反馈。以下将使用特定的常量名来指代一些名词。此处建议读者直接使用教程内容的常量名。在最后再逐一搜索替换。这样可以避免对各种常量名的混淆。

常量名	常量释义
[Blogroot]	本地存放博客源码的文件夹路径
[SourceRepo]	存放博客源码的私有仓库名
[SiteBlogRepo]	存放编译好的博客页面的公有仓库名Site指站点，教程中会替换成Github、Gitee、Coding
[SiteUsername]	用户名 Site指站点，教程中会替换成 Github、Gitee、Coding
[SiteToken]	申请到的令牌码 Site指站点，教程中会替换成 Github、Gitee、Coding
[GithubEmail]	与github绑定的主邮箱，建议使用Gmail
[TokenUser]	Coding配置特有的令牌用户名

# 在记事本中逐个记录，方便替换，以下为我的示例

[Blogroot]：E:\Blogroot

[SourceRepo]：Akilarlxh/Hexo-blog-source

[SiteBlogRepo]
  [GithubBlogRepo]：Akilarlxh.github.io
  [GiteeBlogRepo]：akilar
  [CodingBlogRepo]：akilar/akilar

[SiteUsername]
  [GithubUsername]：Akilarlxh
  [GiteeUsername]：Akilar
  [CodingUsername]：akilar

[SiteToken]
  [GithubToken]：15076c8eb9c874sad676bc9bfb13sadw86babf2
  [GiteeToken]：f57acasdadgar4578603adas5d8w79bb
  [CodingToken]：a4e45daf78as1f2670dcbbcfd5as7d8asd8cd66a77

[GithubEmail]：akilarlxh@gmail.com

[TokenUser]：RAxDiobbRi

Github Action使用教程

获取Token

为了确保交由Github Action来持续部署时，Github Action具备足够的权限来进行hexo deploy操作,需要先获取Token，博主分别在Github、Gitee、Coding处部署了静态页面，所以也就需要获取这三处的Token。

github

访问Github->头像（右上角）->Settings->Developer Settings->Personal access tokens->generate new token,创建的Token名称随意，但必须勾选repo项和workflows项。

gitee

访问Gitee->头像（右上角）->设置->私人令牌->生成新令牌

token只会显示这一次，之后将无法查看，所以务必保证你已经记录下了Token。之后如果忘记了就只能重新生成重新配置了。

创建存放源码的私有仓库

我们需要创建一个用来存放Hexo博客源码的私有仓库[SourceRepo]，这点在Win10的Hexo博客搭建教程中有提到。为了保持教程的连贯，此处再写一遍。

创建完成后，需要把博客的源码push到这里。首先获取远程仓库地址，此处虽然SSH和HTTPS均可。SSH在绑定过ssh key的设备上无需再输入密码，HTTPS则需要输入密码，但是SSH偶尔会遇到端口占用的情况。请自主选择。

这里之所以是私有仓库，是因为在接下来的配置中会用到Token，如果Token被盗用，别人可以肆意操作你的github仓库内容，为了避免这一风险，才选择的博客源码闭源。

配置Github Action

1. 在[Blogroot]新建.github文件夹,注意开头是有个.的。然后在.github内新建workflows文件夹，再在workflows文件夹内新建autodeploy.yml,在[Blogroot]/.github/workflows/autodeploy.yml里面输入

   # 当有改动推送到master分支时，启动Action
   name: 自动部署
   
   on:
     push:
       branches:
         - master #2020年10月后github新建仓库默认分支改为main，注意更改
   
     release:
       types:
         - published
   
   jobs:
     deploy:
       runs-on: ubuntu-latest
       steps:
       - name: 检查分支
         uses: actions/checkout@v2
         with:
           ref: master #2020年10月后github新建仓库默认分支改为main，注意更改
   
       - name: 安装 Node
         uses: actions/setup-node@v1
         with:
           node-version: "12.x" #action使用的node版本，建议大版本和本地保持一致。可以在本地用node -v查询版本号。
   
       - name: 安装 Hexo
         run: |
           export TZ='Asia/Shanghai'
           npm install hexo-cli -g
   
       - name: 缓存 Hexo
         uses: actions/cache@v1
         id: cache
         with:
           path: node_modules
           key: ${{runner.OS}}-${{hashFiles('**/package-lock.json')}}
   
       - name: 安装依赖
         if: steps.cache.outputs.cache-hit != 'true'
         run: |
           npm install --save
   
       - name: 生成静态文件
         run: |
           hexo clean
           hexo generate
   
       - name: 部署 #此处master:master 指从本地的master分支提交到远程仓库的master分支，若远程仓库没有对应分支则新建一个。如有其他需要，可以根据自己的需求更改。
         run: |
           cd ./public
           git init
           git config --global user.name '${{ secrets.GITHUBUSERNAME }}'
           git config --global user.email '${{ secrets.GITHUBEMAIL }}'
           git add .
           git commit -m "${{ github.event.head_commit.message }} $(date +"%Z %Y-%m-%d %A %H:%M:%S") Updated By Github Actions"
           git push --force --quiet "https://${{ secrets.GITHUBUSERNAME }}:${{ secrets.GITHUBTOKEN }}@github.com/${{ secrets.GITHUBUSERNAME }}/${{ secrets.GITHUBUSERNAME }}.github.io.git" master:master
           #git push --force --quiet "https://${{ secrets.TOKENUSER }}:${{ secrets.CODINGTOKEN }}@e.coding.net/${{ secrets.CODINGUSERNAME }}/${{  secrets.CODINGBLOGREPO }}.git" master:master #coding部署写法，需要的自行取消注释
           #git push --force --quiet "https://${{ secrets.GITEEUSERNAME }}:${{ secrets.GITEETOKEN }}@gitee.com/${{ secrets.GITEEUSERNAME }}/${{ secrets.GITEEUSERNAME }}.git" master:master #gitee部署写法，需要的自行取消注释

   注意最后一行的master:master指从本地的master分支提交到远程仓库的master分支,需要根据你自己的实际情况进行调整。本地分支可以在git bash中看到。线上分支可以在提交仓库中查看。因为“政治正确”的原因，github在2020年10月将默认分支改为main。而git软件在本地默认创建的分支依然是master，所以若你线上仓库默认分支是main，这里应该写成master:main，表示从本地的master推送到远程的main。

2. 之后需要自己到仓库的Settings->Secrets->actions 下添加环境变量，变量名参考脚本中出现的，依次添加。
   
   例如，需要部署在githubpage上，那么脚本中必要的变量为
   GITHUBUSERNAME、GITHUBEMAIL、GITHUBTOKEN，因此添加这三条变量。变量具体内容释义可以查看本文开头。
   

重新设置远程仓库和分支

1. 删除或者先把[Blogroot]/themes/butterfly/.git移动到非博客文件夹目录下,原因是主题文件夹下的.git文件夹的存在会导致其被识别成子项目，从而无法被上传到源码仓库。

2. 在博客根目录[Blogroot]路径下运行指令

   git init #初始化
   git remote add origin git@github.com:[GithubUsername]/[SourceRepo].git #[SourceRepo]为存放源码的github私有仓库
   git checkout -b master # 切换到master分支，
   #2020年10月后github新建仓库默认分支改为main，注意更改
   # 如果不是，后面的所有设置的分支记得保持一致

3. 添加屏蔽项
   因为能够使用指令进行安装的内容不包括在需要提交的源码内，所有我们需要将这些内容添加到屏蔽项，表示不上传到github上。这样可以显著减少需要提交的文件量和加快提交速度。
   打开[Blogroot]/.gitignore,输入以下内容：

   .DS_Store
   Thumbs.db
   db.json
   *.log
   node_modules/
   public/
   .deploy*/
   .deploy_git*/
   .idea
   themes/butterfly/.git

   如果不是butterfly主题，记得替换最后一行内容为你自己当前使用的主题。

4. 之后再运行git提交指令，将博客源码提交到github上。牢记下方的三行指令，以后都是通过这个指令进行提交。

git add .
git commit -m "github action update" #引号内的内容可以自行更改作为提交记录。
git push origin master
#2020年10月后github新建仓库默认分支改为main，注意更改

5. 此时你的主题文件夹若已经被正常上传，并且你也添加了主题文件夹下的.git文件夹的屏蔽项。那你可以考虑把第二步移走或删除的.git放回来，用作以后升级。（不禁怀疑真的有人会去用这个方式来升级吗）

查看部署情况

此时，打开GIthub存放源码的私有仓库，找到action。

根据刚刚的Commit记录找到相应的任务

点击Deploy查看部署情况

若全部打钩，恭喜你，你现在可以享受自动部署的快感了。

可能遇到的bug

最新教程已更新在提交至源码仓库章节前作为提示

Unknown block tag:”tagname”

要是在github action部署时遇到unknown block tag: "tagname"这样的报错，说明你可能没有正确上传主题文件夹，也可能遇到安装依赖或生成页面失败的情况。

请按照以下思路逐一排查。

1. 是否将node_modules也上传到源码仓库[SourceRepo]了。源码仓库不需要有node_modules文件夹。
2. 是否有将[Blogroot]/themes/下的主题文件夹上传，例如检查[SourceRepo]内的[Blogroot]/themes/Butterfly是否为空文件夹。为了能够正常编译页面，源码仓库需要有[Blogroot]/themes/Butterfly文件夹及它所包含的主题文件内容。
   为了避免这两点，需要添加git屏蔽项。通过给.gitignore添加屏蔽项解决。
   打开[Blogroot]/.gitignore,输入以下内容：

.DS_Store
Thumbs.db
db.json
*.log
node_modules/
public/
.deploy*/
.deploy_git*/
.idea
themes/butterfly/.git

3. 若是遇到添加屏蔽项，但是还是无法正常上传主题文件夹的情况。
   • 请先将本地源码中的themes/butterfly文件夹下的.git文件夹删除。
   • 然后将butterfly文件夹移动到别的目录下。然后commit一次。
   • 接着将butterfly文件夹移动回来，再commit一次。

变量名称问题

部分不愿意用教程给出的变量名的可能遇到未知bug，此处给出官方的命名规则：

以下规则适用于密码名称：

密钥名称只能包含字母数字字符（[a-z]、[A-Z]、[0-9]）或下划线 (_)。 不允许空格。

密钥名称不得以 GITHUB_ 前缀开头。

密钥名称不能以数字开头。

密钥名称不区分大小写。

密钥名称在所创建的级别上必须是唯一的。

spawn failed

若是遇到spawn failed报错。在github action的配置中出现这一报错。一般是因为涉及到部署地址的配置项有误。

首先排查你在[Blogroot]_config.yml的deploy配置项是否按照上文配置deploy项中的步骤正确组装配置链接。
其次排查[Blogroot].github\workflows\autodeploy.yml中各个关于仓库链接的配置内容，注意按照注释指引检查空格、分支等。
更多可能的因素和解决方案可以参考@洪哥HEO写的方案:Hexo错误：spawn failed的解决方法。

分支问题

本地分支和线上分支不一致导致总是提交不上。
注意观察autodeploy.yml文件中，

git push --force --quiet "https://${{ secrets.GITHUBUSERNAME }}:${{ secrets.GITHUBTOKEN }}@github.com/${{ secrets.GITHUBUSERNAME }}/${{ secrets.GITHUBUSERNAME }}.github.io.git" master:master

末尾的master:master指从本地的master分支提交到远程仓库的master分支。需要根据实际情况进行调整。本地的分支可在git bash中查看。线上的分支可在仓库查看。比如本地默认分支是master，线上默认分支是main，应该改成master:main。
会遇到这类问题，一般是有同学直接全局替换master为main导致。

后记

这里可能有同学要问，github action有啥用？这不就是从hexo cl && hexo g && hexo s的三件套变成了git add .,git commit -m "commit content",git push三件套吗？
其实github action的最大作用就是进一步提高速度和便携性，首先，配置要求提交源码这点，萌新小白就没必要再靠本地不断新建压缩包来备份源码了，借助git的版本管理，不管怎么改都可以快速回滚。
然后，git提交是增量更新，每次只提交新增或者删改的内容，而hexo deploy是在本地每次重新生成所有静态文件以后再整个提交。github action能帮我们节省大把时间，把最耗时的hexo generate和hexo deploy的工作丢给CI处理。让我们能够专心与编写博客内容，而不是水文3分钟，提交半小时。

发散思维

Github action只要监测到master分支有所变动就会启动部署，那么顺着这个思路，手机用户可以在网页Github进行小幅修改，例如修改错别字，调整布局之类的。保存后也会启动Github action，从而将内容部署到网页上去。

2020年10月后github新建仓库默认分支改为main，注意更改

拓展内容

1. 使用Vercel来加速Hexo博客
2. 使用Coding和github来实现双线部署
3. 使用Gitee提供镜像站支持

原创使用Github Action实现全自动部署