Files
SCzhengand修雨 809d026b7e ci: add CLI compatibility and PR quality gates (#602)
* ci(interface): 添加接口完整性和CLI烟雾测试检查

- 在Makefile中新增interface-integrity、update-interface-baseline、cli-smoke和mock-mcp-smoke目标
- 实现接口基线脚本以比较CLI公共命令树与基线文件
- 新增脚本确保二进制文件可渲染所有顶层命令的帮助信息
- 添加mock-mcp-smoke测试验证HTTP和stdio MCP请求/响应传输
- 在GitHub Actions CI工作流中加入interface-integrity、cli-smoke和mock-mcp-smoke检查
- 新增AI行为检查工作流,限制AI生成PR的改动范围和禁改保护文件
- 文档中补充PR质量门禁要求及接口变更流程说明

* feat(policy): 增加多项兼容性和完整性检查

- Makefile中新增reset-interface-baseline、schema-compatibility、update-schema-baseline、skill-command-integrity等目标
- CI流程新增schema-compatibility和skill-command-integrity步骤
- 文档中详细说明接口兼容性基线更新和重置流程及schema基线注意事项
- 实现interface-baseline工具支持兼容性重置和合并,多项接口兼容性检查逻辑完善
- 新增schema-compat工具用于标准化schema列表及兼容性检查与合并
- 新增skill-command-integrity检查确保技能中引用命令存在
- 为interface-baseline和schema-compat添加单元测试覆盖基本兼容性规则

* test(skill-command-check): 增加命令解析和解析结果测试用例

- 补充对 parseReference 函数的边界情况和跳过条件的测试
- 新增 resolveCommandReference 函数测试,覆盖有效、无效及跳过场景
- 增加 isPlaceholder 函数的测试,验证占位符识别准确性

refactor(skill-command-check): 优化命令路径解析和验证逻辑

- 使用 resolveCommandReference 统一处理命令解析结果,清晰区分有效、无效和跳过情况
- 新增 commandResolution 类型及常量,提升代码可读性和扩展性
- 调整 parseReference 增加对 shell 组合符 “ & ” 的跳过处理

docs(mono): 更新最佳实践和产品文档命令示例

- 优化《best_practices/07-minutes.md》中行动项与摘要拉取示例命令,提升准确性
- 修改产品文档中 ALIDOC 表格数据和多维表格记录相关命令,命令路径更规范统一
- 同步多端技能文档,确保命令示例一致且正确

* ci: check interface against PR merge-base

* feat(policy): enforce CLI contract compatibility

* ci: enforce PR coverage thresholds

* ci: add fail-closed CI gate

* ci: adapt schema compatibility gate to runtime catalog

* fix(ci): close schema compatibility gate gaps

* test(auth): skip POSIX mode assertion on Windows

* test(auth): scope POSIX file-backend checks

* fix(ci): enforce native platform coverage

* test(ci): make skill paths portable

---------

Co-authored-by: 修雨 <huyizhou.hyz@alibaba-inc.com>
2026-07-15 14:53:34 +08:00

96 lines
2.8 KiB
Go

// Copyright 2026 Alibaba Group
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
// Command interface-baseline snapshots and checks the backwards-compatible
// public Cobra surface of DWS CLI.
package main
import (
"flag"
"fmt"
"io"
"os"
"github.com/DingTalk-Real-AI/dingtalk-workspace-cli/internal/app"
"github.com/spf13/cobra"
)
func main() {
os.Exit(run(os.Args[1:], app.NewRootCommand(), os.Stdout, os.Stderr))
}
func run(args []string, root *cobra.Command, stdout, stderr io.Writer) int {
var checkPath string
var mergePath string
flags := flag.NewFlagSet("interface-baseline", flag.ContinueOnError)
flags.SetOutput(stderr)
flags.StringVar(&checkPath, "check", "", "check current CLI against a historical baseline")
flags.StringVar(&mergePath, "merge", "", "merge current additions into a historical baseline")
if err := flags.Parse(args); err != nil {
return 2
}
if checkPath != "" && mergePath != "" {
fmt.Fprintln(stderr, "--check and --merge are mutually exclusive")
return 2
}
root.InitDefaultHelpCmd()
current := snapshot(root)
switch {
case checkPath != "":
baseline, err := readContract(checkPath)
if err != nil {
fmt.Fprintf(stderr, "read interface baseline: %v\n", err)
return 2
}
failures := checkCompatibility(root, baseline)
if len(failures) > 0 {
fmt.Fprintln(stderr, "CLI backwards-compatibility check failed:")
for _, failure := range failures {
fmt.Fprintf(stderr, " - %s\n", failure)
}
return 1
}
fmt.Fprintf(stdout,
"interface compatibility check: ok (%d historical command nodes; additions allowed)\n",
len(baseline.Commands),
)
case mergePath != "":
baseline, err := readContract(mergePath)
if err != nil {
fmt.Fprintf(stderr, "read interface baseline: %v\n", err)
return 2
}
merged, failures := mergeContracts(baseline, current)
if len(failures) > 0 {
fmt.Fprintln(stderr, "cannot merge incompatible interface changes:")
for _, failure := range failures {
fmt.Fprintf(stderr, " - %s\n", failure)
}
return 1
}
if err := renderContract(stdout, merged); err != nil {
fmt.Fprintf(stderr, "render merged interface baseline: %v\n", err)
return 2
}
default:
if err := renderContract(stdout, current); err != nil {
fmt.Fprintf(stderr, "render interface baseline: %v\n", err)
return 2
}
}
return 0
}