community.general.github_issue – View GitHub issue.

Note

This plugin is part of the community.general collection (version 3.7.0).

To install it use: ansible-galaxy collection install community.general.

To use it in a playbook, specify: community.general.github_issue.

Synopsis

  • View GitHub issue for a given repository and organization.

Parameters

Parameter Choices/Defaults Comments
action
string
    Choices:
  • get_status ←
Get various details about issue depending upon action specified.
issue
integer / required
Issue number for which information is required.
organization
string / required
Name of the GitHub organization in which the repository is hosted.
repo
string / required
Name of repository from which issue needs to be retrieved.

Examples

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

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

Return Values

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

Key Returned Description
issue_status
string
success
State of the GitHub issue

Sample:
open, closed


Authors

  • Abhijeet Kasurde (@Akasurde)