Add initial github_release module (#1755)

Add initial github_release module.
reviewable/pr18780/r1
Adrian Moisey 9 years ago committed by Adrian Likins
parent 062c7607a4
commit 2ad6f02c7b

@ -0,0 +1,121 @@
#!/usr/bin/python
# -*- coding: utf-8 -*-
#
# This file is part of Ansible
#
# Ansible is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# Ansible is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with Ansible. If not, see <http://www.gnu.org/licenses/>.
DOCUMENTATION = '''
---
module: github_release
short_description: Interact with GitHub Releases
description:
- Fetch metadata about Github Releases
version_added: 2.2
options:
token:
required: true
description:
- Github Personal Access Token for authenticating
user:
required: true
description:
- The GitHub account that owns the repository
repo:
required: true
description:
- Repository name
action:
required: true
description:
- Action to perform
choices: [ 'latest_release' ]
author:
- "Adrian Moisey (@adrianmoisey)"
requirements:
- "github3.py >= 1.0.0a3"
'''
EXAMPLES = '''
- name: Get latest release of test/test
github:
token: tokenabc1234567890
user: testuser
repo: testrepo
action: latest_release
'''
RETURN = '''
latest_release:
description: Version of the latest release
type: string
returned: success
sample: 1.1.0
'''
try:
import github3
HAS_GITHUB_API = True
except ImportError:
HAS_GITHUB_API = False
def main():
module = AnsibleModule(
argument_spec=dict(
repo=dict(required=True),
user=dict(required=True),
token=dict(required=True, no_log=True),
action=dict(required=True, choices=['latest_release']),
),
supports_check_mode=True
)
if not HAS_GITHUB_API:
module.fail_json(msg='Missing requried github3 module (check docs or install with: pip install github3)')
repo = module.params['repo']
user = module.params['user']
login_token = module.params['token']
action = module.params['action']
# login to github
try:
gh = github3.login(token=str(login_token))
# test if we're actually logged in
gh.me()
except github3.AuthenticationFailed:
e = get_exception()
module.fail_json(msg='Failed to connect to Github: %s' % e)
repository = gh.repository(str(user), str(repo))
if not repository:
module.fail_json(msg="Repository %s/%s doesn't exist" % (user, repo))
if action == 'latest_release':
release = repository.latest_release()
if release:
module.exit_json(tag=release.tag_name)
else:
module.exit_json(tag=None)
from ansible.module_utils.basic import *
if __name__ == '__main__':
main()
Loading…
Cancel
Save