Documentation

github_release - Interact with GitHub Releases

New in version 2.2.

Synopsis

  • Fetch metadata about GitHub Releases

Options

parameter required default choices comments
action
yes
  • latest_release
Action to perform
password
(added in 2.4)
no
The GitHub account password for the user
repo
yes
Repository name
token
no
GitHub Personal Access Token for authenticating
user
yes
The GitHub account that owns the repository

Examples

- name: Get latest release of test/test
  github_release:
    token: tokenabc1234567890
    user: testuser
    repo: testrepo
    action: latest_release

- name: Get latest release of test repo using username and password. Ansible 2.4.
  github_release:
    user: testuser
    password: secret123
    repo: testrepo
    action: latest_release

Return Values

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

name description returned type sample
latest_release Version of the latest release success string 1.1.0


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.