ansible.builtin.github_issue (v2.9.27) — module

View GitHub issue.

| "added in version" 2.4 of ansible.builtin"

Authors: Abhijeet Kasurde (@Akasurde)

preview | supported by community

Install Ansible via pip

Install with pip install ansible==2.9.27

Description

View GitHub issue for a given repository and organization.

Usage examples

  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: Check if GitHub issue is closed or not
  github_issue:
    organization: ansible
    repo: ansible
    issue: 23642
    action: get_status
  register: r
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: Take action depending upon issue status
  debug:
    msg: Do something when issue 23642 is open
  when: r.issue_status == 'open'

Inputs

    
repo:
    description:
    - Name of repository from which issue needs to be retrieved.
    required: true

issue:
    description:
    - Issue number for which information is required.
    required: true

action:
    choices:
    - get_status
    default: get_status
    description:
    - Get various details about issue depending upon action specified.

organization:
    description:
    - Name of the GitHub organization in which the repository is hosted.
    required: true

Outputs

get_status:
  description: State of the GitHub issue
  returned: success
  sample: open, closed
  type: str