issue

Inspect the targeted repository’s issues (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.issue.list_(*, milestone=None, state='open', assignee=None, creator=None, mentioned=None, labels=None, sort='created', direction='desc', since=None, per_page=None, fields=None, profile=None)

Return the issues in the targeted repository, based on the search options. Pull requests are excluded.

CLI Example:

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

milestone

Number of a GitHub milestone, or a string of either * or none.

state

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

assignee

Filter returned issues by assigned user handle. Pass none (as a string) for issues with no assigned user or * for issues assigned to any user.

creator

Filter by the username that created the issue.

mentioned

Filter issues for a user that’s mentioned in the issue.

labels

Filter issues by associated labels. String of comma separated label names. For example, bug,ui,@high.

sort

Field to sort results by. Either created, updated, or comments. Default is created.

direction

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

since

Only list issues updated at or after this time. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

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.

saltext.github.resources.github.modules.issue.get(number, *, profile=None)

Return information about a single issue in the targeted repository.

CLI Example:

salt 'my-org/my-repo' issue.get 514

number

Issue number to retrieve.

profile

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

saltext.github.resources.github.modules.issue.get_comments(number, *, since=None, profile=None)

Return the comments of an issue in the targeted repository.

CLI Example:

salt 'my-org/my-repo' issue.get_comments 514

number

Issue number for which to retrieve comments.

since

Only return comments updated at or after this time. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

profile

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