gnuradio/ci

GNU Radio CI容器镜像文档

1. 镜像概述

本镜像专为GNU Radio项目的持续集成（CI）流程设计，提供预配置的运行环境，旨在简化GNU Radio应用及模块的自动化构建、测试与验证过程。镜像集成了GNU Radio核心依赖、构建工具及测试框架，确保在不同CI/CD平台（如GitHub Actions、GitLab CI等）中提供一致的执行环境，减少因环境差异导致的构建失败。

2. 核心功能与特性

• 预配置环境：内置GNU Radio及其依赖库（如Boost、FFTW、Volk等），无需手动安装基础组件
• CI兼容性：针对主流CI/CD平台优化，支持GitHub Actions、GitLab CI、Jenkins等工具的自动化流程集成
• 版本一致性：提供稳定的GNU Radio版本环境，支持多版本标签（如latest、3.10等），满足不同项目的版本需求
• 轻量级设计：基于精简基础镜像构建，平衡功能完整性与资源占用，加速CI流程执行
• 测试工具集成：包含单元测试框架（如CTest、pytest）及代码质量检查工具（如cppcheck、flake8），支持自动化测试流程

3. 使用场景与适用范围

• GNU Radio应用开发：自动化构建与测试自定义GNU Radio流程图、模块或应用程序
• 开源项目维护：为GNU Radio社区模块（如gr-osmosdr、gr-satellites等）提供标准化CI流程
• 多平台验证：在不同GNU Radio版本环境中验证代码兼容性
• 教育与研究：用于学术项目或课程中，确保学生/研究人员使用一致的开发测试环境

4. 使用方法与配置说明

4.1 基本使用（本地测试）

通过docker run命令启动容器，执行GNU Radio相关构建或测试命令：

bash
docker run --rm -v $(pwd):/workspace docker.xuanyuan.run/gnuradio/ci:latest \
  bash -c "cd /workspace && mkdir build && cd build && cmake .. && make && ctest"

• -v $(pwd):/workspace：将本地项目目录挂载到容器内/workspace路径
• gnuradio/ci:latest：镜像名称及标签（可替换为特定版本如3.10）
• 后续命令：典型的CMake构建流程（创建构建目录、配置、编译、运行测试）

4.2 在GitHub Actions中使用

在GitHub仓库的.github/workflows/目录下创建CI配置文件（如gnuradio-ci.yml），示例如下：

yaml
name: GNU Radio CI

on: [push, pull_request]

jobs:
  build-and-test:
    runs-on: ubuntu-latest
    steps:
      - name: Checkout code
        uses: actions/checkout@v4

      - name: Run GNU Radio CI container
        uses: docker://gnuradio/ci:latest
        with:
          args: bash -c "cd /github/workspace && mkdir build && cd build && cmake .. && make && ctest"

• on: [push, pull_request]：触发条件（代码推送或PR时执行）
• docker://gnuradio/ci:latest：直接使用镜像作为步骤执行环境
• args：容器内执行的命令，完成项目构建与测试

4.3 环境变量配置

镜像支持通过环境变量自定义行为，常用变量如下：

• GR_VERSION：指定GNU Radio版本（如3.10.7，需镜像支持对应标签）
• BUILD_TYPE：构建类型，可选Release（默认）或Debug
• TEST_COVERAGE：是否启用测试覆盖率收集，设为1时开启（需项目支持）

示例（带环境变量的docker run命令）：

bash
docker run --rm -v $(pwd):/workspace \
  -e GR_VERSION=3.10.7 \
  -e BUILD_TYPE=Debug \
  docker.xuanyuan.run/gnuradio/ci:3.10 \
  bash -c "cd /workspace && mkdir build && cd build && cmake -DCMAKE_BUILD_TYPE=Debug .. && make && ctest"

5. 注意事项

• 镜像标签与GNU Radio版本对应，使用前需确认项目依赖的GNU Radio版本是否与镜像标签匹配
• 本地测试时，确保挂载的项目目录包含有效的CMakeLists.txt或构建配置文件
• CI平台中需确保容器拥有足够资源（如内存、CPU），复杂项目可能需要调整CI runner配置