community.general.github_issue module – View GitHub issue

Note

This module is part of the community.general collection (version 6.6.2).

You might already have this collection installed if you are using the ansible package. It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.

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

Comments

action

string

Get various details about issue depending upon action specified.

Choices:

  • "get_status" ← (default)

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.

Attributes

Attribute

Support

Description

check_mode

Support: full

Can run in check_mode and return changed status prediction without modifying target.

diff_mode

Support: none

Will return details on what has changed (or possibly needs changing in check_mode), when in diff mode.

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

Description

issue_status

string

State of the GitHub issue

Returned: success

Sample: "open, closed"

Authors

  • Abhijeet Kasurde (@Akasurde)