pull

Inspect the targeted repository’s pull requests (read-only).

Added in version 1.1.0.

Part of the github resource type: all functions operate on the repository the job was dispatched to. The profile parameter defaults to the profile named in the resource declaration.

saltext.github.resources.github.modules.pull.list_(*, state='open', head=None, base=None, sort='created', direction='desc', per_page=None, fields=None, profile=None)

Return the pull requests in the targeted repository, based on the search options.

CLI Example:

salt 'my-org/my-repo' pull.list

state

Filter returned pull requests by their state. Can be either open, closed, or all. Default is open.

head

Filter pull requests by head user and branch name in the format user:ref-name.

base

Filter pulls by base branch name, e.g. gh-pages.

sort

Field to sort results by. Either created, updated, popularity (comment count), or long-running (age, filtering by pull requests updated within the last month). Default is created.

direction

Sort direction. Either asc or desc. Default is desc.

per_page

Pagination size, maximum 100.

fields

Only include these fields in the output. A single field name reduces each entry to the field’s value.

profile

Profile configuration name to use. Defaults to the resource declaration’s profile.