Skip to content

chore: add inline documentation for what BranchResults mean #38851

@jamietanna

Description

@jamietanna

Describe the proposed change(s).

Although it could be inferred by the name, it may be convenient to have more information as to what these actually mean, for folks trying to understand what it means

export type BranchResult =
| 'already-existed'
| 'automerged'
| 'done'
| 'error'
| 'needs-approval'
| 'needs-pr-approval'
| 'not-scheduled'
| 'no-work'
| 'pending'
| 'pr-created'
| 'pr-edited'
| 'pr-limit-reached'
| 'commit-limit-reached'
| 'branch-limit-reached'
| 'rebase'
| 'update-not-scheduled'
| 'minimum-group-size-not-met';

Metadata

Metadata

Assignees

No one assigned

    Labels

    priority-3-mediumDefault priority, "should be done" but isn't prioritised ahead of others

    Type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions