saltext.github.utils.gh.issues¶

Operations on GitHub repository issues.

saltext.github.utils.gh.issues.get(conn, repo_name, number, *, owner=None)[source]¶

Return the raw data of a single issue.

conn: GitHubConnection to use.
repo_name: Repository the issue belongs to.
number: Issue number to retrieve.
owner: Owner of the repository. Defaults to the connection’s owner.

saltext.github.utils.gh.issues.get_comments(conn, repo_name, number, since=None, *, owner=None)[source]¶

Return the raw comment data for a single issue.

conn: GitHubConnection to use.
repo_name: Repository the issue belongs to.
number: Issue number whose comments to retrieve.
since: Only comments updated at or after this time are returned. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
owner: Owner of the repository. Defaults to the connection’s owner.

saltext.github.utils.gh.issues.list_all(conn, repo_name, *, milestone=None, state='open', assignee=None, creator=None, mentioned=None, labels=None, sort='created', direction='desc', since=None, per_page=None, owner=None)[source]¶

Return the raw data of all issues in a repository matching the search options. Pull requests are excluded.

conn: GitHubConnection to use.
repo_name: Repository whose issues to 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.
owner: Owner of the repository. Defaults to the connection’s owner.

saltext.github.utils.gh.issues.format_issue(issue)[source]¶

Format API return information into a more manageable and useful dictionary for issue information.

Legacy function, only used by deprecated callers.

issue: Issue to format.