BranchRule

import type { BranchRule } from "https://googleapis.deno.dev/v1/securesourcemanager:v1.ts";

Metadata of a BranchRule. BranchRule is the protection rule to enforce pre-defined rules on designated branches within a repository.

interface BranchRule {

allowStaleReviews?: boolean;

annotations?: {

[key: string]: string;

};

readonly createTime?: Date;

disabled?: boolean;

etag?: string;

includePattern?: string;

minimumApprovalsCount?: number;

minimumReviewsCount?: number;

name?: string;

requireCommentsResolved?: boolean;

requiredStatusChecks?: Check[];

requireLinearHistory?: boolean;

requirePullRequest?: boolean;

readonly uid?: string;

readonly updateTime?: Date;

}

§Properties

allowStaleReviews?: boolean

[src]

Optional. Determines if allow stale reviews or approvals before merging to the branch.

annotations?: {

[key: string]: string;

}

[src]

Optional. User annotations. These attributes can only be set and used by the user. See https://google.aip.dev/128#annotations for more details such as format and size limitations.

readonly createTime?: Date

[src]

Output only. Create timestamp.

disabled?: boolean

[src]

Optional. Determines if the branch rule is disabled or not.

etag?: string

[src]

Optional. This checksum is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding.

includePattern?: string

[src]

Optional. The pattern of the branch that can match to this BranchRule. Specified as regex. .* for all branches. Examples: main, (main|release.*). Current MVP phase only support .* for wildcard.

minimumApprovalsCount?: number

[src]

Optional. The minimum number of approvals required for the branch rule to be matched.

minimumReviewsCount?: number

[src]

Optional. The minimum number of reviews required for the branch rule to be matched.

name?: string

[src]

Optional. A unique identifier for a BranchRule. The name should be of the format: projects/{project}/locations/{location}/repositories/{repository}/branchRules/{branch_rule}

requireCommentsResolved?: boolean

[src]

Optional. Determines if require comments resolved before merging to the branch.

requiredStatusChecks?: Check[]

[src]

Optional. List of required status checks before merging to the branch.

requireLinearHistory?: boolean

[src]

Optional. Determines if require linear history before merging to the branch.

requirePullRequest?: boolean

[src]

Optional. Determines if the branch rule requires a pull request or not.

readonly uid?: string

[src]

Output only. Unique identifier of the repository.

readonly updateTime?: Date

[src]

Output only. Update timestamp.