关于GitHub Actions的使用

创建时间: 2024-11-29 21:49:11修改时间: 2024-11-29 22:04:03

前言

一直以来我写代码都是写完后再手动部署的,从来没有试过自动化部署。尽管我很久之前就已经听说过GitHub Actions了,但是一直没有使用过,因为人类对待未知的事物总是迷茫的,所以趁这几天有点闲,所以我将我的博客前端仓库用GitHub Actions实现自动部署。

概述

关于GitHub Actions的概述,我觉得还是GitHub官网权威一点了解 GitHub Actions 简单来说就是提供一个工作流,工作流的文件要放在根目录下的.github/workflows/目录里。后缀是yml。github提供了Ubuntu Linux、Microsoft Windows 和 macOS这三种系统来让你在这个系统中构建你的程序。当然你可以选择自托管服务器。

快速入门

github官方教程,工作流中有这么几个关键的信息:

  • name - 工作流的名称
  • run-name - 工作流运行的名称
  • on - 事件触发器 比如push之类的
  • jobs - 任务(直接翻译为工作也是可以的,一个工作流可以有多个任务,每个任务都是互相隔离的)
    • [任务下的就是任务名称,可以随便取名]
      • runs-on - 运行的环境(Ubuntu Linux、Microsoft Windows 和 macOS)
      • steps - 运行的步骤,就和在终端输命令一样,可以一行一行的输入
        • name - 运行步骤的名字,这个其实是可以省略掉的
        • run - 运行步骤的命令

下面就是官方对应的实例demo

name: GitHub Actions Demo
run-name: ${{ github.actor }} is testing out GitHub Actions 🚀
on: [push]
jobs:
  Explore-GitHub-Actions:
    runs-on: ubuntu-latest
    steps:
      - run: echo "🎉 The job was automatically triggered by a ${{ github.event_name }} event."
      - run: echo "🐧 This job is now running on a ${{ runner.os }} server hosted by GitHub!"
      - run: echo "🔎 The name of your branch is ${{ github.ref }} and your repository is ${{ github.repository }}."
      - name: Check out repository code
        uses: actions/checkout@v4
      - run: echo "💡 The ${{ github.repository }} repository has been cloned to the runner."
      - run: echo "🖥️ The workflow is now ready to test your code on the runner."
      - name: List files in the repository
        run: |
          ls ${{ github.workspace }}
      - run: echo "🍏 This job's status is ${{ job.status }}."

关于${{github.xxx}}之类操作就类似于javascript中的模板引擎,里面的参数是工作流上下文

更多基础语法请参阅github官方的GitHub Actions的工作流语法

关于我的博客

我的博客c端使用的是next.js所以我很多操作其实都是用shell来进行部署的, 下面就是我的博客的Actions的配置了,详细信息都在注释中

name: Build LeessminBlogClient
run-name: ${{ github.actor }} is Build out GitHub Actions 🚀
on: [push]
jobs:
  Build-Leessmin-Blog-Client:
    runs-on: ubuntu-latest
    steps:
      - name: Checkout code  uses是可重用的工作流[https://docs.github.com/zh/actions/sharing-automations/reusing-workflows]  actions/checkout@v4 这个工作流是github官方提供的,目的就是将我们仓库中的文件clone到目前的目录中
        uses: actions/checkout@v4
      - name: create build directory 
        run: mkdir build
      - name: Archive LeessminBlogClient
        run: tar --exclude='build' -czf ./build/LeessminBlogClient.tar.gz . # tar压缩必须加 --exclude='build'参数忽略改文件夹,然后把压缩文件放入build目录下,否则tar 会报错(压缩的目录和压缩后的文件不一致),导致GitHub Actions终止
      - name: Echo ls -all
        run: ls -all
      - name: Echo ls ./build
        run: ls ./build -all
        # 2. Install sshpass for non-interactive SSH password authentication
      - name: Install sshpass
        run: sudo apt-get install -y sshpass
        # 3. Upload the build artifact to the server
      - name: Upload build artifact to server
        run: |
          sshpass -p "${{ secrets.SSH_PASSWORD }}" scp -o StrictHostKeyChecking=no -o UserKnownHostsFile=/dev/null ./build/LeessminBlogClient.tar.gz ${{ secrets.SERVER_USER }}@${{ secrets.SERVER_IP }}:/home/leessminblog/nextjs/  # sshpass scp必须要加入 -o StrictHostKeyChecking=no -o UserKnownHostsFile=/dev/null  来阻止连接ssh需要ssh key
        # 4. SSH into the server and deploy the build
      - name: Deploy and restart app using PM2
        run: |
          sshpass -p "${{ secrets.SSH_PASSWORD }}" ssh -o StrictHostKeyChecking=no ${{ secrets.SERVER_USER }}@${{ secrets.SERVER_IP }} << 'EOF'
          # 进入部署目录
          cd /home/leessminblog/nextjs/
          # 解压构建文件
          tar -xzvf LeessminBlogClient.tar.gz -C .
          # 进入解压后的目录
          cd /home/leessminblog/nextjs
          # 安装依赖
          pnpm install
          # 编译项目
          pnpm build
          # 重启应用(如果应用没有启动,则启动它)
          pm2 restart leessminBlogClient || pm2 start "pnpm start" --name "leessminBlogClient"

上述的脚本文件中你可能有注意到一个地方,就是${{ secrets.** }}这个secrets就是敏感信息储存的环境变量,所有敏感信息都应该储存到这里,这样别人中工作流中也是看不到服务器的地址的,只能看到 *** 有关这个敏感信息请参阅GitHub Actions中使用机密。大概流程也就是这个样子了,我的实例主打一个能用就行,没啥高级的命令,都是最基础的shell命令,不过GitHub Actions也挺好玩的,还能大大减轻部署的效率,下次改代码再也不用担心部署太麻烦的问题了,GItHub YYDS