ppiper/action-runtime

Project 'Piper' GitHub Actions 运行时环境

概述

Project 'Piper' GitHub Actions运行时环境是专为支持Project 'Piper'项目的GitHub Actions工作流执行而设计的Docker镜像。该镜像提供了工作流运行所需的完整依赖环境，确保在不同执行环境中保持一致性，简化自动化流程的配置与维护。

核心功能与特性

• 完整运行环境：预配置GitHub Actions执行所需的基础系统组件和工具链
• Piper项目适配：内置Project 'Piper'项目相关的依赖包和运行时支持
• 环境一致性：标准化执行环境，消除因环境差异导致的工作流执行问题
• 兼容性支持：兼容GitHub Actions标准工作流语法和操作
• 轻量级设计：优化镜像体积，减少资源占用和启动时间

使用场景与适用范围

• Project 'Piper'项目的CI/CD自动化流程
• 基于GitHub Actions的代码构建、测试与部署任务
• 需要标准化执行环境的自动化工作流
• 开发团队在GitHub平台上的持续集成与持续部署场景

使用方法与配置说明

基本使用方式

直接运行容器

bash
docker run -it --rm project-piper/github-actions-runtime:latest

在GitHub Actions工作流中使用

在工作流配置文件（.github/workflows/*.yml）中指定该镜像作为执行环境：

yaml
name: Piper CI Workflow
on: [push, pull_request]

jobs:
  build-and-test:
    runs-on: ubuntu-latest
    container:
      image: project-piper/github-actions-runtime:latest
      env:
        PIPER_HOME: /opt/piper
        GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
    
    steps:
      - name: Checkout code
        uses: actions/checkout@v4
      
      - name: Run Piper build
        run: piper build --config=piper-config.yaml
      
      - name: Run tests
        run: piper test --coverage

环境变量配置

持久化数据

如需持久化工作流数据或缓存，可通过挂载卷实现：

bash
docker run -it --rm \
  -v $(pwd)/piper-data:/opt/piper/data \
  -v $(pwd)/piper-cache:/tmp/piper-cache \
  project-piper/github-actions-runtime:latest

版本选择

镜像支持通过标签指定版本，建议在生产环境中使用特定版本而非latest以确保稳定性：

yaml
container:
  image: project-piper/github-actions-runtime:1.2.0

注意事项

• 确保GITHUB_TOKEN拥有足够权限（通常需要repo范围权限）
• 首次运行时可能需要较长时间拉取镜像，请确保网络连接稳定
• 定期更新镜像版本以获取最新安全补丁和功能改进
• 敏感配置建议通过GitHub Secrets管理，避免直接暴露在配置文件中