specsolutions/specsync

SpecSync for Azure DevOps Docker镜像文档

1. 镜像概述和主要用途

SpecSync for Azure DevOps是一款将BDD（行为驱动开发）流程与Azure DevOps（TFS）集成的同步工具。它通过连接并同步BDD场景与测试用例，以及将测试执行结果以关联相关测试用例的方式发布到Azure DevOps，使开发和测试活动对Azure DevOps中的所有利益相关者保持透明和可追溯。

该工具支持任何使用Gherkin语言描述BDD场景的工具，例如SpecFlow或Cucumber。

• 项目网站：[***]
• 详细文档和入门指南：[***]

2. 核心功能和特性

• BDD与Azure DevOps集成：将BDD流程无缝集成到Azure DevOps环境中
• 场景与测试用例同步：连接并同步BDD场景与Azure DevOps测试用例
• 测试结果发布：将测试执行结果发布到Azure DevOps，并保持与相关测试用例的关联
• Gherkin工具支持：兼容所有使用Gherkin语言描述BDD场景的工具（如SpecFlow、Cucumber等）

3. 使用场景和适用范围

SpecSync Docker镜像适用于以下场景：

• 无需本地安装即可执行SpecSync命令行工具的环境
• CI/CD流程中集成SpecSync同步或测试结果发布步骤
• 作为基础镜像派生自定义容器镜像，满足特定业务需求
• 快速评估和实验SpecSync功能
• 生产环境中需要稳定版本控制的SpecSync部署

4. 使用方法和配置说明

4.1 基本使用说明

SpecSync Docker镜像可直接用于执行SpecSync命令行工具。详细的Docker使用文档请参考：[***]

4.2 标签说明

该镜像提供以下类型的标签，用于不同场景的版本控制：

4.2.1 最新发布版本（latest）

• 指向最新发布的SpecSync版本镜像
• 特点：会随新版本发布自动更新
• 建议用途：仅用于评估和实验，不推荐生产环境（新 major 版本可能导致兼容性问题）

4.2.2 最新版本系列（如3.0）

• 指向特定版本系列的最新补丁版本（例如3.0标签指向3.0.x系列的最新补丁）
• 特点：保持版本系列稳定性的同时获取最新补丁修复
• 建议用途：生产环境使用

4.2.3 特定发布版本（如3.0.2）

• 指向版本系列中特定的补丁版本
• 特点：标签始终指向同一镜像，提供最高的可预测性
• 建议用途：需要严格版本控制的生产环境

4.2.4 特定预发布版本（如3.1.0-pre20200903-2）

• 指向特定的预发布版本
• 特点：稳定性较低，包含实验性功能
• 建议用途：仅用于验证特定修复或改进

5. Docker部署示例

5.1 基本命令执行示例

使用最新版本执行SpecSync命令：

bash
docker run --rm specsolutions/specsync:latest --help

5.2 使用特定版本系列执行同步操作

bash
docker run --rm -v $(pwd):/workspace specsolutions/specsync:3.0 sync -c /workspace/specsync.json

5.3 生产环境推荐配置（使用特定版本系列）

bash
docker run --rm -v $(pwd):/workspace specsolutions/specsync:3.0 push -c /workspace/specsync.json

注：上述命令中的specsync.json为SpecSync配置文件，需根据实际项目需求进行配置。详细配置说明请参考官方文档。