Hexo+GitHub Actions 完美打造个人博客

程序员文章站 2022-05-27 19:05:41

Hexo简介 Hexo是一款基于Node.js的静态博客框架，依赖少易于安装使用，可以方便的生成静态网页托管在GitHub和Coding上，是搭建博客的首选框架。大家可以进入hexo官网进行详细查看，因为Hexo的创建者是*人，对中文的支持很友好，可以选择中文进行查看。 Hexo搭建步骤安装Gi ......

hexo简介

hexo是一款基于node.js的静态博客框架，依赖少易于安装使用，可以方便的生成静态网页托管在github和coding上，是搭建博客的首选框架。大家可以进入hexo官网进行详细查看，因为hexo的创建者是*人，对中文的支持很友好，可以选择中文进行查看。

hexo搭建步骤

安装git
安装node.js
安装hexo
编写github actions
推送到github
发布文章

我们的开发过程是在win环境下，本质和环境没关系，影响不大，首先我们要保证我们的电脑上安装了git 与node.js 其中git是为了我们方便检出与推送我们的代码，node.js是为了构建hexo的脚手架，生成项目结构，我们在在后面提供生成好的项目结构源码，这样子我们也不需要node.js了，不过还是建议大家自己来构建，灵活操作，本地浏览构建项目也需要

上述两个环境我们不在这里阐述，如果不懂安装的可以百度，我们直接从hexo的脚手架构建开始

hexo 安装与项目初始化

首先我们可以用 cmd命令窗口或者vscode里命令窗口，都一样，这里我们使用vscode因为后期项目的ide就用vocode ;

打开vscode 软件，按 ctrl+ `调出命令窗口，输入

cd h:\project\    -- 切换到我们项目要放的目录下

node -v     -- 查看node的环境版本

npm -v  -- 查看 npm 的版本

通过这两个命令来查询我们node.js的安装情况如下，则显示正常

Hexo+GitHub Actions 完美打造个人博客

执行命令 npm install -g hexo-cli 来安装hexo的脚手架支持，这是安装到node的插件中，

Hexo+GitHub Actions 完美打造个人博客
上述显示下载好cli程序，接下类我们开始初始化项目

创建项目目录名字自己定，比如 'myblog'

命令： mkdir myblog 、

初始化hexo项目 mylog

命令： hexo init 项目目录名 这里就是： hexo init myblog

Hexo+GitHub Actions 完美打造个人博客

等待构建好，上面显示就已经构建好了，接下来我们直接通过vscode来打开项目目录 myblog

Hexo+GitHub Actions 完美打造个人博客

新建完成后，指定文件夹目录下有：
1. node_modules : 依赖包
2. public ：存放生成的页面
3. scaffolds ：生成文章的一些模板
4. source ：用来存放你的文章
5. themes ：主题
6. ** _config.yml : 博客的配置文件**
这时候我们咋控制台可以直接命令编译启动项目

cd .\myblog\`

npm install

在执行时可能会出现下面问题

Hexo+GitHub Actions 完美打造个人博客
简单翻译就是：
5 个包正在寻找募款，执行 npm fund 查看详情（募捐链接）；
发现一个发现 1 个低严重性漏洞，执行 npm audit fix 进行修复, 或 npm audit 查看更多信息。
通过命令 npm audit 详细信息为：

=== npm audit security report ===                        

          manual review                                  
        some vulnerabilities require your attention to resolve             
                                                                          
    visit https://go.npm.me/audit-guide for additional guidance           

  low             prototype pollution                                           

  package         minimist                                                      

  patched in      >=0.2.1 <1.0.0 || >=1.2.3                                     

  dependency of   hexo                                                          

  path            hexo > swig-templates > optimist > minimist                   

  more info       https://npmjs.com/advisories/1179                             

found 1 low severity vulnerability in 470 scanned packages
  1 vulnerability requires manual review. see the full report for details.

若出现这些信息，根据提示做也可不做。我们直接忽略就行了，不影响我们的项目

通过 hexo s启动项目，通过访问

Hexo+GitHub Actions 完美打造个人博客
效果如下：

Hexo+GitHub Actions 完美打造个人博客

我们可以通过 hexo g 来生成静态文件，在 public 目录下，类似如下：

Hexo+GitHub Actions 完美打造个人博客

上述是我们本地搭建运行的结果，但是在我们后面的使用中每次都要自己来生动生成静态页面是非常麻烦的事，我们完全可以交给github来做这件事

github actions实现自动部署

什么是 github actions，的介绍是：
with github actions you can automate your workflow from idea to production.
有点抽象，但是我们知道 github 是什么啊，代码仓库，一个提供了分布式版本控制和源代码管理的代码仓库。在实际场景中，比如你写好了一个网站的代码，并且存储到了 github 上，就可以了吗，并灭有没有，你还需要部署代码才能让别人访问你的网站。另外，如果你修改了代码，还需要单独测试。理想的情况应该是：当你将代码提交到 master 时，测试、部署等等所有工作自动执行。现在有了 github actions，就可以帮我们实现这些功能，
github actions 可以自动化和定制化项目的 workflow，像官网显示的那样。

Hexo+GitHub Actions 完美打造个人博客

首先我们了解一下github actions 的一些术语

（1）workflow （工作流程）：持续集成一次运行的过程，就是一个 workflow。
（2）job （任务）：一个 workflow 由一个或多个 jobs 构成，含义是一次持续集成的运行，可以完成多个任务。
（3）step（步骤）：每个 job 由多个 step 构成，一步步完成。一个工作中的每个步骤都在相同的虚拟环境中执行，从而允许使用文件系统共享信息。
（4）action （动作）：每个 step 可以依次执行一个或多个命令（action）。你可以创建自己的action、使用 github 社区共享的action。

这里我们不在阐述过多的知识，推荐大家去网上看，或者去这里-> github actions 入门教程 - 阮一峰的网络日志, 个人感觉还是很优秀的文章，可以学习！！

部署到腾讯云

下面我们贴出我们的配置（部署到腾讯云cloudbase）

name: github actions build and deploy
on:
  push:
    branches:

      - master

jobs:
  build-and-deploy:
    runs-on: ubuntu-latest
    steps:

    - name: 1. git checkout...

      uses: actions/checkout@v1

    - name: 2. setup nodejs...

      uses: actions/setup-node@v1

    - name: 3. install hexo...

      run: |
        npm install hexo-cli -g
        npm i -s hexo-prism-plugin -g
        npm install hexo-generator-search --save -g
        npm i hexo-permalink-pinyin  -g
        npm i --save hexo-wordcount -g
        npm install hexo-filter-github-emojis  -g
        npm install hexo-generator-feed  -g
        npm install

    - name: 4. hexo generate public files...

      run: |
        hexo clean
        hexo g
    # 部署到腾讯云    

    - name: deploy static to tencent cloudbase

      id: deploystatic
      uses: tencentcloudbase/cloudbase-action@v1
      with:
        secretid: ${{ secrets.secret_id }}
        secretkey: ${{ secrets.secret_key }}
        envid: ${{ secrets.env_id }}
        staticsrcpath: ./public

    - name: get the deploy result

      run: echo "deploy to cloudbase result ${{ steps.deploystatic.outputs.deployresult }}"

对上面内容做一个简单说明，其实这就是在github的一个容器里面跑的

首先checkout 出来我们的代码到容器，这些actions都有人写了我们直接用就好，
然后加载 uses: actions/setup-node@v1 的环境，也就是支持了node.js的环境
然后再 run下面编写我们正常使用的命令就行，最后通过hexo g生成静态文件，
下面是用来腾讯的静态网站托管服务的actions ,需要配置几个属性secret_id、secret_key、env_id

部署到githubpage

有些小伙伴像直接用githubpage来作为承载对象，那么实现也是非常简单的，上面项目推送github一样，作为源代码仓库，可以直接私有化，actions的配置里面需要修改一下后面说
需要在github上新建一个仓库作为存放生成的静态文件，这个仓库的命令有着要求，格式： github用户名.github.io 按照这个来创建仓库，如果你用户名为 admin 那么仓库名就是 admin.github.io
创建好后，不要创建任何文件里面，保持空的即可，在源代码的仓库中配置 github actions 的配置文件，和上面的类似，只有后面不服不同，具体如下：

name: github actions build and deploy
on:
  push:
    branches:

      - master

jobs:
  build-and-deploy:
    runs-on: ubuntu-latest
    steps:

    - name: 1. git checkout...

      uses: actions/checkout@v1

    - name: 2. setup nodejs...

      uses: actions/setup-node@v1

    - name: 3. install hexo...

      run: |
        npm install hexo-cli -g
        npm i -s hexo-prism-plugin -g
        npm install hexo-generator-search --save -g
        npm i hexo-permalink-pinyin  -g
        npm i --save hexo-wordcount -g
        npm install hexo-filter-github-emojis  -g
        npm install hexo-generator-feed  -g
        npm install

    - name: 4. hexo generate public files...

      run: |
        hexo clean
        hexo g
    
    # 提交到我们的存放静态资源的仓库

    - name: build and deploy

      uses: y4code/hexo-deploy-action@master
      env:
        personal_token: ${{ secrets.access_token }}
        publish_repository: it-briefcode/it-briefcode.github.io # the repository the action should deploy to.
        branch: master  # the branch the action should deploy to.
        publish_dir: ./public # the folder the action should deploy.