You are reading an unmaintained version of the Ansible documentation. Unmaintained Ansible versions can contain unfixed security vulnerabilities (CVE). Please upgrade to a maintained version. See the latest Ansible documentation.

github_issue - View GitHub issue.¶

New in version 2.4.

Synopsis
Requirements (on host that executes module)
Options
Examples
Return Values
- Status

Synopsis ¶

View GitHub issue for a given repository.

Requirements (on host that executes module)¶

github3.py >= 1.0.0a4

Options ¶

parameter	required	default	choices	comments
action	no	get_status	[u'get_status']	Get various details about issue depending upon action specified.
issue	yes	none		Issue number for which information is required.
organization	yes	none		Name of the GitHub organization in which the repository is hosted.
repo	yes	none		Name of repository from which issue needs to be retrieved.

Examples ¶

- name: Check if GitHub issue is closed or not
  github_issue:
    organization: ansible
    repo: ansible
    issue: 23642
    action: get_status
  register: r

- name: Take action depending upon issue status
  debug:
    msg: Do something when issue 23642 is open
  when: r.issue_status == 'open'

Return Values ¶

Common return values are documented here Return Values, the following are the fields unique to this module:

name	description	returned	type	sample
get_status	State of the GitHub issue	success	string	open, closed

Status ¶

This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.

For help in developing on modules, should you be so inclined, please read Community Information & Contributing, Testing Ansible and Developing Modules.