Interface GitPullRequestCompletionOptions

Preferences about how the pull request should be completed.

interface GitPullRequestCompletionOptions {
    autoCompleteIgnoreConfigIds?: number[];
    bypassPolicy?: boolean;
    bypassReason?: string;
    deleteSourceBranch?: boolean;
    mergeCommitMessage?: string;
    mergeStrategy?: GitPullRequestMergeStrategy;
    squashMerge?: boolean;
    transitionWorkItems?: boolean;
    triggeredByAutoComplete?: boolean;
}

Properties

autoCompleteIgnoreConfigIds? bypassPolicy? bypassReason? deleteSourceBranch? mergeCommitMessage? mergeStrategy? squashMerge? transitionWorkItems? triggeredByAutoComplete?

Properties

OptionalautoCompleteIgnoreConfigIds

autoCompleteIgnoreConfigIds?: number[]

List of any policy configuration Id's which auto-complete should not wait for. Only applies to optional policies (isBlocking == false). Auto-complete always waits for required policies (isBlocking == true).

OptionalbypassPolicy

bypassPolicy?: boolean

If true, policies will be explicitly bypassed while the pull request is completed.

OptionalbypassReason

bypassReason?: string

If policies are bypassed, this reason is stored as to why bypass was used.

OptionaldeleteSourceBranch

deleteSourceBranch?: boolean

If true, the source branch of the pull request will be deleted after completion.

OptionalmergeCommitMessage

mergeCommitMessage?: string

If set, this will be used as the commit message of the merge commit.

OptionalmergeStrategy

mergeStrategy?: GitPullRequestMergeStrategy

Specify the strategy used to merge the pull request during completion. If MergeStrategy is not set to any value, a no-FF merge will be created if SquashMerge == false. If MergeStrategy is not set to any value, the pull request commits will be squashed if SquashMerge == true. The SquashMerge property is deprecated. It is recommended that you explicitly set MergeStrategy in all cases. If an explicit value is provided for MergeStrategy, the SquashMerge property will be ignored.

OptionalsquashMerge

squashMerge?: boolean

SquashMerge is deprecated. You should explicitly set the value of MergeStrategy. If MergeStrategy is set to any value, the SquashMerge value will be ignored. If MergeStrategy is not set, the merge strategy will be no-fast-forward if this flag is false, or squash if true.

OptionaltransitionWorkItems

transitionWorkItems?: boolean

If true, we will attempt to transition any work items linked to the pull request into the next logical state (i.e. Active -> Resolved)

OptionaltriggeredByAutoComplete

triggeredByAutoComplete?: boolean

If true, the current completion attempt was triggered via auto-complete. Used internally.

Settings

Member Visibility

On This Page

Properties