GitHub Actions自动化部署前端项目指南

·  阅读 555
GitHub Actions自动化部署前端项目指南

前言

在项目开发过程中,随着需求的不断变化以及后期不断修复bug,伴随着的便是我们不停的打包部署。打包部署这期间的操作虽然不复杂,但是非常繁琐。目前市面上可以使用jenkens等工具实现持续集成(CI/CD),但是如果我们服务器资源少,且只需要简单的自动化部署,那么有更优雅的方式实现自动化部署:GitHub Actions。

本篇文章以前端项目为例,下文所有操作基于前端项目。

1.什么是GitHub Actions?

GitHub Actions是GitHub推出的一款持续集成(CI/CD)服务,它给我们提供了虚拟的服务器资源,让我们可以基于它完成自动化测试、集成、部署等操作。

传统的前端项目开发流程:

  1. 前端人员完成所有开发
  2. 推送代码
  3. 打包生成静态资源文件
  4. 推送至服务端
  5. ...依次循环

可以看到传统的前端项目开发流程其实并不复杂,但是很繁琐,开发人员需要不断地重复2~4步骤,若是遇到加急bug,那么这些不太复杂的操作就会浪费不少时间。

使用GitHub Actions的前端项目开发流程:

  1. 前端人员完成所有开发
  2. 推送代码
  3. GitHub Actions自动部署
  4. ...依次循环

使用GitHub Actions后工作就变得非常简单了,开发人员只需要专注开发,每次推送完代码后便自动完成了部署,免去了很多繁琐的操作。

大家可以简单的把Actions理解为脚本,一个Action就是一个自动化部署脚本,GitHub官方为了方便大家操作,允许发布自己的Action到Actions市场去,这样一些常用的部署脚本就不需要自己写了,只需要使用别人造好的轮子即可。

2.概念介绍

在使用GitHub Actions之前,它的几个基本概念必须要了解一下:

  • Workflows(工作流程)

持续集成的运行过程称为一次工作流程,也就是我们项目开始自动化部署到部署结束的这一段过程可以称为工作流程,一个工作流程中由一个或者多个任务(job)组成。

  • Jobs(任务)

一个工作流程中包含多个任务,简单来说就是一次自动部署的过程中,需要完成一个或多个任务,这些任务里面又包含了多个步骤(step)。

  • Step(步骤)

我们开发项目需要按照一个一个的步骤来进行,自动部署也一样,在一个任务中,步骤需要一步步的完成。

  • Action(动作)

每个步骤(step)可以包含一个或多个动作,比如我们在一个步骤中执行打包命令这个Action。

上面4点是GitHub Actions中几个大的概念,也很好理解,大家可以把它想象为一条完整的流水线,流水线包含的几个操作要点如下:

workflow->job->step->action

3.语法简介

上面的概念介绍只是从宏观层面解读的,具体如何实现还需要我们了解具体的额语法,就好比一个工人修房子,具体步骤是知道了,那么具体工具还需要确定,这些工具就是我们需要了解的GitHub Actions语法。

3.1 name

定义workflow的名称,如果没有定义,则会默认使用执行脚本文件名作为workflow名称,实例代码如下:

name: GitHub Actions Demo
复制代码

3.2 on

触发workflow的条件或者事件,比如push的时候就像执行workflow,实例代码如下:

# 单个事件
on: push

# 多个事件列表
on: [push, pull_request]

# 当main分支发生push操作时执行workflow
on:
  push:
    branches:
      - main
复制代码

3.3 jobs

jobs是一个workflow的核心任务,我们大部分的操作在jobs中完成,我们的任务(job)放在jobs这个集合下,每一个job有以下几个核心的字段组成:

(1)jobs.<job_id>

jobs中每一项任务都有任务id,实例代码如下:

jobs:
  my_first_job:   // 任务id
    name: My first job
  my_second_job:
    name: My second job
复制代码

(2)jobs.<job_id>.name

每一项任务具有任务名称,好比我们做每一项工作时都有一个工作名称,实例代码如下:

jobs:
  my_first_job:  
    name: My first job  // 任务任务名称
  my_second_job:
    name: My second job
复制代码

(3)jobs.<job_id>.needs

needs字段用来指定当前任务的一些依赖关系,比如一个任务依赖于另外两个任务,实例代码如下:

jobs:
  job1:
  job2:
    needs: job1
  job3:
    needs: [job1, job2]
复制代码

上面代码展示了三个任务之间的依赖关系,所以执行顺序应该是job1、job2、job3.

(3)jobs.<job_id>.runs-on

该字段用来指定命令的运行虚拟机环境,可以理解为我们的任务要在哪个环境中执行,实例代码如下:

runs-on: ubuntu-18.04
复制代码

GitHub Actions给我们提提供的运行环境主要有以下几种:

  • ubuntu-latestubuntu-18.04ubuntu-16.04
  • windows-latestwindows-2019windows-2016
  • macOS-latestmacOS-10.14

(4)jobs.<job_id>.steps

step是job中的重点,一个job可以包含多个步骤,比如一个项目就是一个任务,我们需要分为多个步骤来完成这个项目,实例代码如下:

每个步骤包含下面三个字段:

jobs.<job_id>.steps.name:步骤名称。
jobs.<job_id>.steps.run:该步骤运行的命令或者 action。
jobs.<job_id>.steps.env:该步骤所需的环境变量。
复制代码

上面代码中run就是我们该步骤需要执行的命令,比如打包命令:npm run build。当然也可以使用人家造好的轮子,直接使用人家的action。

以上只是简单介绍了GitHub Actions中重要的一些概念和语法,以满足我们基本的自动化部署操作,更多详细语法可以移步官网:

GitHub Actions官网

4.部署实例

上面几节主要介绍了GitHub的一些基础知识,了解时候就可以进行实战了,这里使用Vue项目作为演示项目。

4.1 准备工作

  • 前端项目(Vue)
  • GitHub账号
  • 服务器资源(或者使用github pages)

4.2 初始化项目

(1)初始化一个Vue项目

在本地任意地方初始化一个Vue项目,初始化命令如下:

vue create myproject
复制代码

项目的相关配置任意选择,最后项目运行起来如下:

(2)推送至GitHub

在GitHub上新建一个项目,我们就取名为github-actions-demo:

然后我们将初始化的Vue项目推送至GitHub,在Vue项目根目录依次执行以下命令:

git remote add origin https://github.com/Hacker233/github-actions-demo.git
git branch -M main
git push -u origin main
复制代码

上面的git地址记得切换为自己的,此时我们的项目已经推送成功了,接下来我们要实现的就是只要main分支有代码推送,则执行自动化部署。

4.3 服务器配置nginx

为了方便后面测试,我们可以先把网站部署到服务器上去,也就是我们先提前配好nginx,如果你自己有网站且已经部署成功了,则可跳过此节。

如果不知道如何部署到服务器的小伙伴可以参考:

文章:

前端Vue项目打包部署实战教程

视频:

前端Vue项目打包部署实战教程

部署完成后我们就可以通过域名或者服务器IP访问我们的网站了:

4.4 新建.yml文件

(1)进入GitHub Actions菜单

(2)点击set up a workflow yourself

当然你也可以选择一个模板,点击start commit则会自动在我们项目目录下新建.github/workflows/main.yml文件,yml文件内容默认即可,先不用管。

而且此时会发现,我们的提交记录旁边有一个小绿点,其实那就代表着我们的action正在执行,切换到actions菜单,会发现actions已经执行了一次了,且成功了。

我们更新以下本地的代码,在本地修改yml配置文件。

4.5 修改.yml文件

我们可以简单的看一下默认生成的yml文件,是不是和我们前几节讲的概念和语法一样,很好理解,我们部署前端项目,通常很简单,只需要简单修改即可。

先给出完整的yml代码:

name: Build app and deploy to Tencent
on:
  #监听push操作
  push:
    branches:
      # mian分支,你也可以改成其他分支
      - main
jobs:
  # 任务ID
  build:
    # 运行环境
    runs-on: ubuntu-latest
    # 步骤
    steps:
    # 使用别人的action
    - uses: actions/checkout@v2
    # 步骤名称
    - name: npm install
      # 步骤执行指令
      run: npm install
    - name: npm run build
      run: npm run build
    # 命名这个任务为发布Deploy
    - name: Deploy
      # 因为构建之后,需要把代码上传到服务器上,所以需要连接到ssh,并且做一个拷贝操作
      uses: cross-the-world/scp-pipeline@master
      env:
        WELCOME: "ssh scp ssh pipelines"
        LASTSSH: "Doing something after copying"
      with:
        host: ${{ secrets.USER_HOST }}
        user: ${{ secrets.USER_NAME }}
        pass: ${{ secrets.USER_PASS }}
        connect_timeout: 10s
        local: './dist/*'
        remote: /home/www/dist
复制代码

上面的代码是在默认的yml文件上修改的,重点需要关注的是jobs,这里我们只有一个任务,任务id就是build,该任务里面有3个步骤,也就是我们项目部署通常的3个步骤:

  • npm install 安装项目依赖
  • npm run build 打包项目
  • deploy 将打包好的静态资源推送到服务端

在deploy这个步骤中,使用了一个别人写好的action,主要目的就是推送静态资源到服务端,几个重点字段解释:

  • host:服务器ip
  • user:服务器登录用户
  • pass:服务器登录密码
  • connect_timeout:登陆超时限制
  • local:本地的静态资源文件,Vue项目打包后会生成dist文件夹
  • remote:服务端静态资源文件存放路径

【注意】更改yml文件后可能会触发actions,如果没有配置密钥,应该是会部署失败的。

4.6 配置部署密钥

在4.5节中的yml文件中的部署步骤中,服务器的ip、用户名和密码我们都没有直接写在文件里面,这也是为了安全考虑,所以从secrets中读取的,那么接下来我们就去secrets中设置:

(1)进入secrets

点击setting->选择secrets->点击新建

(2)设置相关密钥信息

名称可以任意取,但是要和yml中的相对应,设置后的结果如下:

4.7 更改代码并推送

当我们yml文件和密钥都准备完成之后,这个时候便可以任意修改 一点代码然后push到分支上了,push成功之后,actions便会运行,可以点击进去查看详情:

部署成功:

actions部署完成后,我们就可以访问网站看是否更新了:

如果actions部署失败,可以根据报错日志自行检查一下,一般报错信息很明确的。

总结

GitHub Actions给我们提供了一站式的自动化部署体验,最重要的还是免费,让我们无需再去学会多的部署工具,如jenkens了,这种方式是多么的优雅。

除此之外,GitHub Actions可以部署我们的任何项目,其中的重点当然是我们的yml脚本了。

分类:
前端
标签:
收藏成功!
已添加到「」, 点击更改