community.general.github_issue module – View GitHub issue
Note
This module is part of the community.general collection (version 8.6.4).
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.
Aliases: source_control.github.github_issue
Parameters
Parameter |
Comments |
---|---|
Get various details about issue depending upon action specified. Choices:
|
|
Issue number for which information is required. |
|
Name of the GitHub organization in which the repository is hosted. |
|
Name of repository from which issue needs to be retrieved. |
Attributes
Attribute |
Support |
Description |
---|---|---|
Support: full |
Can run in |
|
Support: none |
Will return details on what has changed (or possibly needs changing in |
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 |
---|---|
State of the GitHub issue Returned: success Sample: |