betomorrow/ci-flutter

ci-flutter 镜像文档

镜像概述和主要用途

ci-flutter 是一个为 Gitlab CI/CD 流水线设计的便捷镜像，集成了多种开发、部署工具及云服务客户端，旨在简化 CI/CD 流程中的环境配置、代码拉取、依赖管理和应用部署等环节。

最新标签

• v17

核心功能和特性

内置工具集

• 基础工具：Bash、Curl、OpenSSH、jq、zip、git、python3
• 云服务 CLI：AWS CLI、Google Cloud CLI、Azure CLI
• CI/CD 辅助工具：SSH 密钥管理、Git 配置工具、预览部署命令、Dependency Track 集成

核心特性

• 预置 Gitlab/GitHub SSH 主机密钥，简化代码拉取认证
• 支持 SSH 密钥自动注入与管理，集成 ssh-agent
• 云服务自动登录（AWS ECR、Google Artifact Registry）
• 提供 Web/移动应用预览部署命令，支持 Slack 通知
• 集成 Dependency Track 漏洞扫描报告上传功能
• 可通过环境变量启用调试模式，便于问题排查

使用场景和适用范围

适用场景

• Gitlab CI/CD 流水线中的构建、测试、部署阶段
• 多平台应用（Web/移动）的自动化构建与预览
• 云服务（AWS/GCP/Azure）资源的 CI/CD 管理
• 依赖项安全扫描报告上传（Dependency Track 集成）

适用范围

• 需要集成多工具链的复杂 CI/CD 流程
• 涉及跨云服务部署的项目
• 需自动化管理 SSH 密钥、Git 配置的场景
• 需快速部署预览版本并通知团队的开发流程

详细使用方法和配置说明

Shell 环境

镜像默认提供 Bash shell，内置以下工具，可直接用于脚本执行：
curl、OpenSSH、jq、zip、git、python3、AWS CLI、Google Cloud CLI

SSH 配置

预置主机密钥

镜像已预置 gitlab.com 和 github.com 的 SSH 主机密钥（详见文件），无需手动配置 StrictHostKeyChecking。

环境变量

Git 配置

环境变量

命令

Amazon Web Service (AWS) CLI

默认区域：eu-west-1

环境变量

命令

Azure CLI

无特定环境变量或命令，可直接使用原生 az 命令。

Google Cloud CLI

环境变量

预览部署

提供 Web 和移动应用的预览部署功能，支持通知集成。

环境变量

命令

Dependency Track 集成

用于上传软件物料清单（BOM）至 Dependency Track 进行漏洞扫描。

环境变量

命令

调试

部署方案示例

示例 1：Gitlab CI/CD 配置（.gitlab-ci.yml）

yaml
stages:
  - build
  - deploy-preview

variables:
  CIBTO_GIT_USER_NAME: "CI Bot"
  CIBTO_GIT_USER_EMAIL: "ci@example.com"
  CIBTO_SSH_KEY_MY_REPO: "$SSH_PRIVATE_KEY"  # 注入 SSH 密钥
  CIBTO_PREVIEWS_SERVER_URL: "https://previews.example.com"
  CIBTO_PREVIEWS_TOKEN: "$PREVIEWS_JWT_TOKEN"
  CIBTO_PREVIEWS_SLACK_HOOK_URL: "$SLACK_HOOK"

build_web:
  stage: build
  image: ci-flutter:v17
  script:
    - git-set-key "$CIBTO_SSH_KEY_MY_REPO_PATH"  # 使用注入的 SSH 密钥配置 Git
    - git clone git@github.com:example/project.git  # 拉取代码
    - cd project && npm install && npm run build  # 构建静态 Web 应用
    - push_web_preview ./dist frontend  # 部署 Web 预览

deploy_mobile_preview:
  stage: deploy-preview
  image: ci-flutter:v17
  script:
    - flutter build appbundle  # 构建 Flutter 应用
    - push_mobile_preview "app-debug.aab" "build/app/outputs/bundle/debug/app-debug.aab" android  # 部署移动预览

示例 2：本地测试（docker run）

bash
# 启动容器并挂载本地 SSH 密钥、设置调试模式
docker run -it --rm \
  -e CIBTO_DEBUG=1 \
  -e CIBTO_SSH_KEY_TEST="$HOME/.ssh/id_rsa" \
  -e CIBTO_GIT_USER_NAME="Local Test" \
  -e CIBTO_GIT_USER_EMAIL="test@example.com" \
  ci-flutter:v17 /bin/bash

# 在容器内执行命令
git-set-key "$CIBTO_SSH_KEY_TEST_PATH"  # 配置 Git SSH
git clone git@gitlab.com:example/repo.git  # 测试代码拉取

示例 3：AWS ECR 登录并推送镜像

bash
docker run -it --rm \
  -e CIBTO_AWS_ECR_AUTO_LOGIN=1 \
  -e AWS_ACCESS_KEY_ID="$AWS_ACCESS_KEY" \
  -e AWS_SECRET_ACCESS_KEY="$AWS_SECRET_KEY" \
  ci-flutter:v17 \
  sh -c "aws-ecr-login us-east-1 && docker push ***.dkr.ecr.us-east-1.amazonaws.com/my-app:latest"