Documentation

github_issue - View GitHub issue.

New in version 2.4.

Synopsis

  • View GitHub issue for a given repository.

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.

Support

This module is community maintained without core committer oversight.

For more information on what this means please read Module Support

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