通过Github Action打包部署到Linux服务器

最近想重新开始写博客了,于是基于Astro搭建博客系统,开始只是将博客发布到github.io,后来自己申请了域名,就有了通过Github Actions将博客部署到云服务器的需求。

由于之前没有经验,在这个过程中遇到了一些问题,所以在这里记录一下这些问题及解决过程。

一、部署过程

整个部署过程如下图:

部署过程

部署过程一共经过五个步骤:

  1. 推送代码: 开发人员将代码推送到github
  2. 触发构建: Github Actions服务被push事件触发,并开始执行时间定义的工作流(.github/workflows/*.yml)
  3. 执行构建: 在yml文件中定义的工作流任务被执行,包括拉取镜像、拉取代码、安装依赖、构建等
  4. 执行部署: 当构建完成后,通过yml文件中声明的部署步骤,将资源部署到云服务器
  5. 查看变更: 当以上四步都完成了,我们打开博客站点,就可以看到最新的页面
  • 对应上面的过程,我们的yml文件如下:
name: Deploy to mysite
on:
  push:
    branches:
      - main
jobs:
  build:
    runs-on: ubuntu-latest
    steps:
      - name: Checkout the repository using git
        uses: actions/checkout@v3
      - name: Install Node.js
        uses: actions/setup-node@v4
        with:
          node-version: 20
      - uses: pnpm/action-setup@v3
        name: Install pnpm
        with:
          version: 8
          run_install: true
      - name: Install dependencies
        run: pnpm install
      - name: Build
        run: pnpm run build:mysite
      - name: Deploy to Server
        uses: easingthemes/ssh-deploy@main
        with:
          # 本地.ssh文件下的私钥id_rsa,存在secrets的PRIVATE_KEY中
          SSH_PRIVATE_KEY: ${{ secrets.PRIVATE_KEY }}
          # 复制操作的参数。"-avzr --delete"意味部署时清空服务器目标目录下的文件
          ARGS: "-avz --delete"
          # 源目录
          SOURCE: "./dist/"
          # 部署目标主机
          REMOTE_HOST: ${{ secrets.HOST }}
          # 部署目标主机端口
          REMOTE_PORT: ${{ secrets.PORT }}
          # 登录用户
          REMOTE_USER: ${{ secrets.USER }}
          # 部署目标目录
          TARGET: ${{ secrets.TARGET }}

上面文件中的${{ secrets.PRIVATE_KEY }}代码,表示引用一个Github仓库中的一个密码配置,每个Github仓库都有这个配置项,可以自定义多个配置,下文会详细介绍如何配置。

二、用到的工具库和遇到的问题

序号工具名称工具类型问题及原因
1github代码托管平台不知道ssh key和环境变量在哪配
2easingthemes/ssh-deploySSH文件上传SSH登录失败,配置的私钥格式不对
3ssh & ssh-keygenLinux远程登录生成的秘钥对格式不对

上面列举了我在配置的过程中遇到的一些问题,接下来我们就一个一个地解决上述问题。

三、SSH免密登录

由于部署过程我们需要让运行Github Action的服务器能够将文件上传到云服务器,需要通过SSH(scp和rsync都是基于SSH进行数据传输的)进行数据传输。
为了保障云服务器安全,我们不能直接将密码暴露给Github Action,因此我们需要实现SSH免密登录。

(一) SSH免密登录原理

  • SSH免密登录原理图

SSH免密登录

可以看出,SSH免密登录共分为六个步骤,其中前两个步骤是我们需要关注,而后面的四步是SSH协议的内部实现,我们不用太关注。

(二)SSH秘钥对生成(坑点)

  • 官方文档中给的生成方式(免密登录会失败,对应问题序号3)如下:
ssh-keygen -m PEM -t rsa -b 4096
  • 后来在issue中找到的成功的生成方式
ssh-keygen -t rsa -b 4096

执行完上面的命令,会生成两个文件,分别为~/.ssh/id_rsa(私钥)和~/.ssh/id_rsa.pub(公钥)。

(三)秘钥部署和验证

  1. 服务端部署: 我们将公钥拷贝到服务器上,并存到~/.ssh/authorized_keys文件中。
  2. 验证: 我们通过ssh命令登录对应服务器,不再需要密码,则SSH免密登录已成功启用了。

四、秘钥配置

现在,云服务器已经配置好了,接下来我们需要将生成秘钥以及部署到云服务器的相关配置配到Github上。

  1. 找到配置页面(位于Repository --> Settings --> Secrets And Variables --> Actions页面中),如下图:

Github秘钥配置

  1. 点击New Secret按钮,进入新增页,填写并新增即可新增一个键值对,如下图:

Github秘钥新增

  1. 坑点:配置公钥的时候,公钥内容必须在最后添加回车换行,否则授权会失败(对应问题序号2)

我们通过这个步骤配置的键值对,可以在我们的yml文件中通过${{ secrets.SOME_KEY }}来引用名为SOME_KEY的值,且这个值在yml中无法打印,如果尝试打印则看到的是***,以保障我们秘钥的安全。

总结

至此,我们的Github Action打包并部署到云服务之旅就圆满结束啦,在这个过程中我的主要收获:

  1. 学会了Github Action的基本使用
  2. 掌握了Github Action工作流配置文件(yml)访问密码键值对的配置及代码写法
  3. 了解了SSH免密登录的工作原理和实践知识
  4. 学会通过查阅github issue找到对应工具坑点及解决方案

由于笔者的水平所限,文章可能存在不足和谬误,恳请不吝指正^_^

⚡ 站长自研 · 极客在线工具箱 (Rust + WebAssembly) 查看全部工具 →
🔥 爆款 · 视频转GIF 视频转 GIF 动图在线制作工作台(支持帧率调节、色彩量化压缩与无水印导出) 📸 逐帧截图 · 台词拼图 视频高清逐帧截图、批量抽帧提取与九宫格故事板/台词长图拼接器 🎞️ 格式转换 · 音频提取 本地视频格式转换、码率瘦身压缩与无损音频 (WAV) 一键提取工作台 🔒 100% 本地 · 隐私级 100% 本地隐私级 WebP / AVIF / PNG / JPEG 批量转换压缩与 EXIF 擦除工作台 🎭 表情包 · 拆帧倒放 GIF 动图拆帧提取、一键倒放、变速抽帧瘦身与表情包字幕合成工坊 🪪 证件照 · 精准控KB 隐私级证件照/考试报名照换底色、精准控制 KB 大小与六寸冲印排版器 🛡️ 证件防盗 · 纯本地 身份证/营业执照/房产证防盗用隐私平铺水印相机与正反面 A4 拼版工具 🎵 音频剪辑 · 铃声截取 纯本地可视化音频波形剪辑、淡入淡出、变速变调与手机铃声截取器 🏠 提前还贷 · 省息决策 房贷(商贷/公积金/组合贷)与提前还贷划算度决策计算器(缩短年限 vs 减少月供) 🚗 买车避坑 · 油电对比 购车全款落地价、4S店车贷费率转真实年化 (IRR) 与油车 vs 电车 5 年回本计算器 🔍 利率照妖镜 · 真实IRR 信用卡分期 / 网贷 / 融资租赁真实年化利率 (IRR) 照妖镜与砍头息穿透计算器 💰 个税筹划 · 年终奖盲区 薪资五险一金税后到手 & 年终奖个税“多发1元多交数千税”临界盲区筹划计算器 🛒 凑单退货 · 外卖拼单AA 电商大促凑单满减退货实付分摊 & 多人点外卖/聚餐红包运费公平 AA 计算器 📈 复利定投 · FIRE退休 复利定投收益、通胀购买力折现与 FIRE(4%法则提前退休/养老金)财务自由模拟器 🏁 永久活码 · 扫码识别 全能艺术二维码生成工坊(WiFi连接码/挪车码/名片码)与本地批量扫码解码器 🏷️ 电商仓储 · A4批量排印 电商/仓储条形码 (EAN-13 / Code128 / UPC-A) 批量生成、校验位计算与 A4 不干胶排版打印 📄 零上传PDF · 转长图/合成 100% 本地零上传 PDF 页面提取、PDF 转高清长图与多图排版合成 A4 PDF 工作台 ✍️ 透明签名 · 扫描件漂白 手写签名照一键抠出透明背景电子签名 (PNG/SVG) & 手机拍文档去黑底阴影漂白器 🖥️ 屏幕坏点 · 键鼠双击验机 显示器屏幕坏点/漏光/高刷帧率 (Hz) & 鼠标微动双击故障/键盘全键无冲在线验机台 🏮 亲戚称呼 · 人生900格 中国三姑六婆亲戚称呼计算器 & 精确周岁虚岁/节气星座/人生 900 个月格子可视化 🎨 自媒体 · 爆款排版 自媒体爆款社交分享卡片与金句排版生成工坊 💼 自由职业 · 商务单据 自由职业者极速隐私报价单、服务确认函与商业发票生成器 💳 跨境支付 · 汇损穿透 全球跨境支付渠道真实手续费、隐性汇损与到账净额精算器 📊 独立开发 · SaaS 沙盘 独立开发与 Micro-SaaS 核心单元经济学、现金流推演与并购估值沙盘 🔥 热门 · Rust Wasm 全球大模型 (LLM API) Token 分词可视化与成本对比计算器 🔄 全栈多语言 · 离线转换 全栈多语言类型与数据结构转换工场 (JSON / YAML / SQL DDL / cURL) 📱 移动开发 · 博客联动 App 唤醒 (DeepLink / Universal Links / App Links) 配置生成与扫码调试器 🛡️ 免连钱包 · 离线安全 多链 RPC 节点真实延迟测速 & 交易 Calldata / ABI 离线安全解码器 🧪 原理实验室 · Vue3 编译 Vue 3 编译三步曲 (Token → AST → PatchFlags & Block Tree) 交互式可视化器 🧪 原理实验室 · 事件循环 JavaScript 事件循环 (Event Loop) 全队列单步推演沙盒(光杆站长模型) 🧪 原理实验室 · 快速 Diff Vue 3 响应式依赖收集 (Track/Trigger) 与快速 Diff (最长递增子序列 LIS) 步进推演器 🧪 原理实验室 · HTTP/3 HTTP/2 (TCP) vs HTTP/3 (QUIC) 0-RTT 握手与丢包队头阻塞 (HoL) 对比模拟器