Interface GitHubBranch

Represents a GitHub branch.

See

https://docs.github.com/en/rest/branches/branches#get-a-branch

interface GitHubBranch {
    commit: { sha: string; url: string };
    name: string;
    protected: boolean;
    protection?: {
        enabled: boolean;
        required_status_checks:
            | null
            | { contexts: string[]; enforcement_level: string };
    };
}

Properties

commit name protected protection?

Properties

commit

commit: { sha: string; url: string }

The latest commit on this branch

Type declaration

  • sha: string

    Commit SHA

  • url: string

    API URL to the commit

name

name: string

Branch name (e.g., 'main', 'feature/my-feature')

protected

protected: boolean

Whether this branch is protected

Optionalprotection

protection?: {
    enabled: boolean;
    required_status_checks:
        | null
        | { contexts: string[]; enforcement_level: string };
}

Branch protection details (only present when using authenticated requests)

Type declaration

  • enabled: boolean

    Whether protection is enabled

  • required_status_checks: null | { contexts: string[]; enforcement_level: string }

    Required status checks

Settings

Member Visibility

On This Page

Properties