文档

单应用变更持续交付最佳实践

更新时间:

本文主要介绍微服务架构下,单应用独立开发、集成测试、持续交付最佳实践。

适用场景

微服务架构下,每个应用服务独立开发、独立发布,小步快跑,持续快速交付业务需求。多人协同开发同一个应用时,分支开发模式是一个适合的协同方案。该模式下一个需求或任务通常对应一个 feature 分支,多个需求一起合并到 release 分支进行集成测试验证并发布。期间可能遇到以下问题:

  • 痛点1:当开发同学领到一个需求时,怎么为这个需求快速的拉一个 feature 分支?

  • 痛点2:当多个相关需求一起发布时,多个 feature 分支怎么高效自动化的合并到 release 分支?

  • 痛点3:当其中一个 feature 分支没有经过测试验证时,怎么“阻止”它发布到生产环境避免漏测引起故障?

  • 痛点4:当其中一个 feature 分支做了测试验证,但是发现有严重问题,怎样可以“退出”本次发布而不影响其他需求正常发布?

  • 痛点5:当一个需求 feature 分支提交测试了、发布上线了,怎么自动、及时的更改相应需求状态,便于相关业务、产品、测试同学跟踪进度?

image.png

云效解决方案

云效应用交付平台 AppStack 提供变更持续交付解决方案,涉及核心概念如下:

  • 应用:一个软件的最小发布单元,聚合代码、环境、版本等软件资产,以及研发流程定义。最小发布单元意味着无法解耦的一个或者多个服务的组合,这个服务组合会通过一个流程进行统一交付。

  • 变更:变更是对应用的一次特性改变(引入新的特性或改变已有特性),源于需求,终于交付。通常一个需求或任务对应一个变更,对应一个 feature 分支。

  • 研发流程:应用完成一次变更的过程和约束,包括开发、测试、发布上线的完整流程,由多个阶段的多条流水线承载,依次在不同环境进行测试、构建、部署,最终审批通过后发布生产环境。

image.png

云效操作实践

以下实践,以一个spring-boot应用的“图书馆管理系统”为例,开发“图书借阅功能”、“图书归还功能”、“图书到期续借功能”三个需求,一起发布上线。

作为应用负责人

作为应用负责人,需要编排应用构建、部署流程,通过流水线工具自动化起来;需要定义应用生产发布准则,来规范应用研发流程降低发布风险。

新建应用

新建应用,输入应用名称,应用模板选择「变更持续交付模式」。

image.png

代码源配置

应用设置,配置应用代码源,设置默认分支。

image.png

配置研发流程

(研发流程配置操作步骤变更持续交付模式。)

本应用的研发流程可以分为测试阶段、预发阶段、生产阶段:

  • 测试阶段:由Java单元测试、Java代码扫描、构建、部署测试环境等步骤组成。用于日常测试验证。

  • 预发阶段:由构建、部署预发环境等步骤组成。用于预发布验证。

  • 生产阶段:由构建、生产发布审批(人工卡点)、部署生产环境、合并主干、关闭变更等步骤组成。

  • 生产发布审批通过后,部署生产环境。

  • 生产环境部署验证通过后,表明本次发布成功,可以将发布release 分支合并回主干 master,并自动关闭相关变更。

image.png

设置变更集成方式和准入规则

本示例各阶段都选择「添加变更集成」方式,在运行阶段流水线时可以选择多个变更分支集成到release分支进行构建部署验证。

  • 测试阶段:无准入规则。

  • 预发阶段:配置准入规则为:「测试阶段-执行结果」等于「成功」,避免没有经过测试验证的分支直接进入预发。

  • 生产阶段:配置准入规则为:「测试阶段-执行结果」等于「成功」,「预发阶段-执行结果」等于「成功」,避免没有经过预发验证的分支直接进入生产阶段。

image.png

作为一线开发

“需求1:图书借阅功能”、“需求2:图书归还功能”、“需求3:图书到期续借功能”三个需求分别分配给开发小张、小明、小强开发。

第1步,为一个需求新建一个变更拉一个 feature 分支

小张创建一个变更「变更1-实现图书借阅功能」,选择新建分支输入 feature001,则可自动为该需求拉取一个分支(解决上述痛点1)。依次类推,小明创建一个变更「变更2-实现图书归还功能」,自动新建分支feature002。小强创建一个变更「变更3-实现到期续借功能」,自动新建分支feature003。

image.png

第2步,开发代码提交到 feature 分支

小张开发好图书借阅相关代码后,提交代码到feature001上,小明开发图书归还相关代码后,提交代码到feature002分支上。

第3步,选择变更集成,部署测试环境验证

小张和小明,一借一还,需要一起部署到测试环境进行联调验证。进入应用研发流程页,选择变更1和变更2一起集成测试,云效会自动将 feature001 和 feature002 合并到自动生成的 release/xxx_n 分支(解决上述痛点2),使用该 release 分支做构建,并部署环境。环境部署成功即可进行测试验证。

image.png

image.png

第4步,提交变更进行预发布

测试环境验证通过,进入「预发阶段」,选择变更1和变更2进行集成,勾选自动合并上一阶段集成的分支,会自动生成新的 release/xxx_m 集成分支,自动合并上一阶段 feature001、feature002、release/xxx_n 分支,使用新的 release/xxx_m 分支构建并部署预发环境。预发部署成功后即可进行预发验证。

image.png

image.png

此时若在预发阶段选择变更1、变更2、变更3一起集成,则经过变更准入卡点时会校验失败,因为变更3没有在测试环境部署验证过,即保证了没有经过测试验证的需求不可发布(解决上述痛点3)。

image.png

变更3因没有测试验证通过,不满足发布条件,团队本次决定图书续借功能不上线,只上线变更1和变更2,则可再次运行预发阶段流水线,将变更3踢出集成区,退出本次发布(解决上述痛点4)。

image.png

第5步,提交变更进行生产发布

预发验证通过后,即可进入生成发布阶段。选择待发布的变更1和变更2,运行生产流水线,发布审批通过后,即可部署生产环境。生产环境部署完成,可配置自动关闭变更,并将发布 release/xxx_k 分支合并入主干 master,至此即完成了一次完整的需求发布上线。

作为业务产品同学

变更发布完成了,我作为PD同学怎么知道需求发布了呢?云效AppStack变更和Projex工作项做了状态联动,支持变更发布完成自动将需求状态置为「已发布」,这样PD同学可及时看到需求进展(解决上述痛点5)。具体配置方式如下:进入Projex项目-项目设置-自动化规则,选择「支持工作项与变更状态的联动」模板,配置当产品类需求关联的全部变更状态为「已发布」时,将需求状态置为「已完成」。

image.png

至此,本方案完成了从应用配置、到需求开发、多变更集成测试、发布上线的完整流程,满足了变更分支自动创建、变更分支自动合并集成测试、发布准入卡点控制等诉求,支持变更关联业务需求和状态联动,完整追溯需求的全生命周期流程。

  • 本页导读 (0)