SuperAPI AI 工具集

enforcing-stability-in-ci

通用与其它

查看项目

更新于 10-16 01:07

技能介绍

用途:把 Compose 稳定性当作契约来对待,像二进制兼容性基线一样提交 .stability 基线,并在每次 PR 中比对;当某个 Composable 变得不可跳过或某个类变得不稳定时让构建失败。

主要能力:通过 Gradle 插件生成每个模块、每个变体的 .stability 基线文件;在 CI 中执行稳定性检查并比对已提交的基线;支持忽略包/类与 stability_config.conf;输出可评审的纯文本差异;Android 项目推荐用 skydoves 插件,Kotlin Multiplatform/桌面/iOS 可用 j-roskopf/ComposeGuard,其主要任务是 <variant>ComposeCompilerGenerate 与 <variant>ComposeCompilerCheck。

必要用法:先应用插件(com.github.skydoves.compose.stability.analyzer,版本 0.7.3),需在 Compose 编译器插件之后应用;配置 composeStabilityAnalyzer 块,在 stabilityValidation 中设置 enabled、outputDir(放在模块内并提交到版本控制,不要放在 build/)、failOnStabilityChange.set(true) 作为提交默认值,并可通过 Gradle 属性在本地临时覆盖;然后本地运行 ./gradlew :app:stabilityDump 或 ./gradlew :app:debugStabilityDump 生成基线并 git add/commit;在 CI 的编译作业中运行 ./gradlew assemble :app:stabilityCheck,失败时上传报告。回退处理:修复导致不稳定的类型并重跑 dump,或有理由地更新基线并在 PR 说明。

适用场景:希望在 CI 中强制稳定性 SLO、迁移到强跳过需要回归保护、多模块 monorepo 统一稳定性实践的场景。

限制与前提:需要 Kotlin 2.0+ 与 Compose 编译器 Gradle 插件、Gradle 8+、可提交基线文件的 CI/仓库;仅单个开发者抛弃型原型、尚未诊断稳定性现状、或只想理解编译器分类原因的场景不建议使用;必须先完成稳定性诊断再设基线,且插件应覆盖所有 UI 模块,忽略项必须注明理由。具体效果与实际收益暂无提供。