GitPullRequestCompletionOptions interface
有关如何完成拉取请求的首选项。
属性
| auto |
自动完成的任何策略配置 ID 的列表不应等待。 仅适用于可选策略(isBlocking == false)。 自动完成始终等待所需的策略(isBlocking == true)。 |
| bypass |
如果为 true,则拉取请求完成后,将显式绕过策略。 |
| bypass |
如果绕过策略,则此原因会存储为为何使用绕过。 |
| delete |
如果为 true,则拉取请求的源分支将在完成后删除。 |
| merge |
如果已设置,则会将其用作合并提交的提交消息。 |
| merge |
指定用于在完成期间合并拉取请求的策略。 如果未将 MergeStrategy 设置为任何值,则如果 SquashMerge == false,则会创建 no-FF 合并。 如果未将 MergeStrategy 设置为任何值,则如果 SquashMerge == true,则拉取请求提交将被挤压。 SquashMerge 属性已弃用。 建议在所有情况下显式设置 MergeStrategy。 如果为 MergeStrategy 提供显式值,将忽略 SquashMerge 属性。 |
| squash |
SquashMerge 已弃用。 应显式设置 MergeStrategy 的值。 如果 MergeStrategy 设置为任何值,将忽略 SquashMerge 值。 如果未设置 MergeStrategy,则如果此标志为 false,则合并策略将不快进,如果为 true,则为 squash。 |
| transition |
如果为 true,我们将尝试将链接到拉取请求的任何工作项转换为下一个逻辑状态(即 Active -> Resolved) |
| triggered |
如果为 true,则通过自动完成触发当前完成尝试。 在内部使用。 |
属性详细信息
autoCompleteIgnoreConfigIds
自动完成的任何策略配置 ID 的列表不应等待。 仅适用于可选策略(isBlocking == false)。 自动完成始终等待所需的策略(isBlocking == true)。
autoCompleteIgnoreConfigIds: number[]
属性值
number[]
bypassPolicy
如果为 true,则拉取请求完成后,将显式绕过策略。
bypassPolicy: boolean
属性值
boolean
bypassReason
如果绕过策略,则此原因会存储为为何使用绕过。
bypassReason: string
属性值
string
deleteSourceBranch
如果为 true,则拉取请求的源分支将在完成后删除。
deleteSourceBranch: boolean
属性值
boolean
mergeCommitMessage
如果已设置,则会将其用作合并提交的提交消息。
mergeCommitMessage: string
属性值
string
mergeStrategy
指定用于在完成期间合并拉取请求的策略。 如果未将 MergeStrategy 设置为任何值,则如果 SquashMerge == false,则会创建 no-FF 合并。 如果未将 MergeStrategy 设置为任何值,则如果 SquashMerge == true,则拉取请求提交将被挤压。 SquashMerge 属性已弃用。 建议在所有情况下显式设置 MergeStrategy。 如果为 MergeStrategy 提供显式值,将忽略 SquashMerge 属性。
mergeStrategy: GitPullRequestMergeStrategy
属性值
squashMerge
SquashMerge 已弃用。 应显式设置 MergeStrategy 的值。 如果 MergeStrategy 设置为任何值,将忽略 SquashMerge 值。 如果未设置 MergeStrategy,则如果此标志为 false,则合并策略将不快进,如果为 true,则为 squash。
squashMerge: boolean
属性值
boolean
transitionWorkItems
如果为 true,我们将尝试将链接到拉取请求的任何工作项转换为下一个逻辑状态(即 Active -> Resolved)
transitionWorkItems: boolean
属性值
boolean
triggeredByAutoComplete
如果为 true,则通过自动完成触发当前完成尝试。 在内部使用。
triggeredByAutoComplete: boolean
属性值
boolean