pub struct GitPullRequestCompletionOptions {
    pub auto_complete_ignore_config_ids: Vec<i32>,
    pub bypass_policy: Option<bool>,
    pub bypass_reason: Option<String>,
    pub delete_source_branch: Option<bool>,
    pub merge_commit_message: Option<String>,
    pub merge_strategy: Option<MergeStrategy>,
    pub squash_merge: Option<bool>,
    pub transition_work_items: Option<bool>,
    pub triggered_by_auto_complete: Option<bool>,
}
Expand description

Preferences about how the pull request should be completed.

Fields

auto_complete_ignore_config_ids: Vec<i32>

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).

bypass_policy: Option<bool>

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

bypass_reason: Option<String>

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

delete_source_branch: Option<bool>

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

merge_commit_message: Option<String>

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

merge_strategy: Option<MergeStrategy>

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.

squash_merge: Option<bool>

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.

transition_work_items: Option<bool>

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

triggered_by_auto_complete: Option<bool>

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

Implementations

Trait Implementations

Returns a copy of the value. Read more

Performs copy-assignment from source. Read more

Formats the value using the given formatter. Read more

Returns the “default value” for a type. Read more

Deserialize this value from the given Serde deserializer. Read more

This method tests for self and other values to be equal, and is used by ==. Read more

This method tests for !=.

Serialize this value into the given Serde serializer. Read more

Auto Trait Implementations

Blanket Implementations

Gets the TypeId of self. Read more

Immutably borrows from an owned value. Read more

Mutably borrows from an owned value. Read more

Returns the argument unchanged.

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more

Instruments this type with the current Span, returning an Instrumented wrapper. Read more

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Should always be Self

The resulting type after obtaining ownership.

Creates owned data from borrowed data, usually by cloning. Read more

Uses borrowed data to replace owned data, usually by cloning. Read more

The type returned in the event of a conversion error.

Performs the conversion.

The type returned in the event of a conversion error.

Performs the conversion.

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more