BetterCap项目从Travis CI迁移到GitHub Actions的实践指南
背景介绍
BetterCap是一款功能强大的网络攻击和监控工具,采用Go语言编写。在持续集成/持续交付(CI/CD)流程中,项目原先使用Travis CI作为构建平台。然而随着Travis CI取消免费计划,项目团队决定将构建流程迁移到GitHub Actions平台。
迁移挑战
迁移过程中面临几个主要技术挑战:
- 多平台构建支持:需要同时支持Linux、macOS和Windows三大操作系统
- 架构兼容性:需处理amd64、arm64等多种CPU架构
- 依赖管理:不同平台需要安装不同的依赖包
- 自动化发布:构建完成后自动创建发布版本并上传二进制文件
GitHub Actions解决方案
基本工作流配置
项目创建了一个名为"Build and Test"的工作流,触发条件设置为当推送带有"v*.."格式的标签时自动运行。工作流包含三个主要任务:构建(build)、测试(test)和部署(deploy)。
多平台构建矩阵
通过GitHub Actions的矩阵策略,实现了多平台并行构建:
strategy:
matrix:
os: [ubuntu-latest, macos-latest, windows-latest]
go-version: ['1.16.x']
include:
- os: ubuntu-latest
arch: amd64
target_os: linux
target_arch: amd64
- os: ubuntu-latest
arch: arm64
target_os: linux
target_arch: aarch64
- os: macos-latest
arch: amd64
target_os: darwin
target_arch: amd64
- os: macos-latest
arch: arm64
target_os: darwin
target_arch: arm64
- os: windows-latest
arch: amd64
target_os: windows
target_arch: amd64
output: bettercap.exe
平台特定依赖处理
针对不同操作系统,工作流中设置了特定的依赖安装步骤:
Ubuntu系统依赖
- name: Install Dependencies on Ubuntu
if: runner.os == 'Linux'
run: sudo apt-get update && sudo apt-get install -y p7zip-full libpcap-dev libnetfilter-queue-dev libusb-1.0-0-dev
macOS系统依赖
- name: Install Dependencies on macOS
if: runner.os == 'macOS'
run: brew install libpcap libusb p7zip
Windows系统依赖
- name: Install Dependencies on Windows
if: runner.os == 'Windows'
run: |
choco install openssl.light -y
choco install make -y
choco install 7zip -y
choco install pkgconfiglite -y
mkdir C:\pkg-config
choco install zadig -y
curl -L "下载libusb" -o "C:\libusb.7z"
7z x -y "C:\libusb.7z" -o"C:\libusb"
curl -L "下载WinPcap" -o "C:\wpcap-sdk.zip"
7z x -y "C:\wpcap-sdk.zip" -o"C:\winpcap"
cp builder\libusb.pc C:\pkg-config\libusb.pc
cp builder\libusb.pc C:\pkg-config\libusb-1.0.pc
构建与验证流程
构建过程使用项目自带的Makefile,针对不同平台设置相应的环境变量:
- name: Build
run: |
make -e TARGET="${{ env.OUTPUT }}"
- name: Verify Build
run: |
file "${{ env.OUTPUT }}"
openssl dgst -sha256 "${{ env.OUTPUT }}" | tee bettercap_${{ matrix.target_os }}_${{ matrix.target_arch }}_${{ env.VERSION }}.sha256
7z a "bettercap_${{ matrix.target_os }}_${{ matrix.target_arch }}_${{ env.VERSION }}.zip" "${{ env.OUTPUT }}" "bettercap_${{ matrix.target_os }}_${{ matrix.target_arch }}_${{ env.VERSION }}.sha256"
自动化发布
构建完成后,工作流会自动创建发布版本并上传构建产物:
- name: Upload Release Assets
uses: softprops/action-gh-release@v1
with:
files: |
bettercap_*.zip
bettercap_*.sha256
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
技术要点总结
-
矩阵策略应用:通过矩阵策略实现了多平台、多架构的并行构建,大大提高了CI效率。
-
条件执行:利用runner.os条件判断,实现了不同操作系统下的差异化处理。
-
依赖隔离:各平台的依赖安装相互隔离,避免了环境冲突。
-
构建产物处理:自动生成SHA256校验和并将二进制文件打包压缩,便于分发。
-
安全发布:使用GitHub Token进行安全认证,确保发布过程的安全性。
最佳实践建议
-
对于Go项目,建议使用actions/setup-go@v4来设置Go环境,它提供了更好的缓存支持和性能优化。
-
在多平台构建时,建议先在小范围内测试各平台的构建脚本,确认无误后再扩大矩阵范围。
-
Windows平台的依赖管理较为复杂,建议使用Chocolatey这样的包管理工具来简化流程。
-
发布前务必验证构建产物的完整性和可用性,SHA256校验是一个简单有效的方法。
-
考虑添加构建缓存步骤,可以显著提高后续构建的速度。
通过这次迁移,BetterCap项目成功实现了从Travis CI到GitHub Actions的平稳过渡,不仅保持了原有的多平台构建能力,还获得了更快的构建速度和更紧密的GitHub生态系统集成。
cherry-studio
🍒 Cherry Studio 是一款支持多个 LLM 提供商的桌面客户端TypeScript037RuoYi-Vue3
🎉 (RuoYi)官方仓库 基于SpringBoot,Spring Security,JWT,Vue3 & Vite、Element Plus 的前后端分离权限管理系统Vue0403arkanalyzer
方舟分析器:面向ArkTS语言的静态程序分析框架TypeScript040GitCode百大开源项目
GitCode百大计划旨在表彰GitCode平台上积极推动项目社区化,拥有广泛影响力的G-Star项目,入选项目不仅代表了GitCode开源生态的蓬勃发展,也反映了当下开源行业的发展趋势。02CS-Books
🔥🔥超过1000本的计算机经典书籍、个人笔记资料以及本人在各平台发表文章中所涉及的资源等。书籍资源包括C/C++、Java、Python、Go语言、数据结构与算法、操作系统、后端架构、计算机系统知识、数据库、计算机网络、设计模式、前端、汇编以及校招社招各种面经~01openGauss-server
openGauss kernel ~ openGauss is an open source relational database management systemC++0145
热门内容推荐
最新内容推荐
项目优选









