一个 danger-swift 插件,用于检查 PR 是否符合特定的工作流(例如 Git-Flow)
将依赖包添加到你的 Package.swift
文件中,你在其中导入了 danger-swift
// swift-tools-version:5.5
...
let package = Package(
...
dependencies: [
...
// Danger Plugins
.package(name: "DangerSwiftEda", url: "https://www.github.com/yumemi-inc/danger-swift-eda.git", from: "0.1.0"),
...
],
...
)
将正确的导入添加到你的 Dangerfile.swift
文件
import DangerSwiftEda
只需像这样将依赖导入添加到你的 Dangerfile.swift
文件中
import DangerSwiftEda // package: https://github.com/yumemi-inc/danger-swift-eda.git
根据你想执行的工作流设置配置(目前仅支持 Git-Flow)
let configuration = GitFlowCheckConfiguration(
// ...
)
提示:我们也有 GitFlowCheckConfiguration.default
,如果你只想使用默认配置。
使用 eda.checkPR
方法执行工作流检查,该方法在 DangerDSL
实例中可用
danger.eda.checkPR(workflow: .gitFlow(configuration)) // Assume you have initialized `danger` by code like `let danger = Danger()`
上面的代码将使 danger 生成如下的 markdown 消息
检查项 结果 基分支检查 🎉 合并提交不存在性检查 🎉 代码差异量检查 🤔 ChangeLog 修改检查 🤔
警告 ⚠️ 此 PR 在 CHANGELOG.md 中没有任何修改。请考虑更新 ChangeLog。 ⚠️ 代码差异过大。请缩小 PR 的大小。