Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

clarify ansible-galaxy collection cli command options #59470

Merged
merged 3 commits into from
Jul 25, 2019
Merged

clarify ansible-galaxy collection cli command options #59470

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
6d79ced
clarify ansible-galaxy collection cli command options
samccann Jul 23, 2019
b8a9487
clarify install
samccann Jul 23, 2019
42b4670
fixed typo
samccann Jul 23, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
9 changes: 7 additions & 2 deletions lib/ansible/cli/galaxy.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -383,6 +383,8 @@ def execute_collection(self):
def execute_build(self):
"""
Build an Ansible Galaxy collection artifact that can be stored in a central repository like Ansible Galaxy.
By default, this command builds from the current working directory. You can optionally pass in the
collection input path (where the ``galaxy.yml`` file is).
"""
force = context.CLIARGS['force']
output_path = GalaxyCLI._resolve_path(context.CLIARGS['output_path'])
Expand All @@ -400,6 +402,7 @@ def execute_build(self):
def execute_init(self):
"""
Creates the skeleton framework of a role or collection that complies with the Galaxy metadata format.
Requires a role or collection name. The collection name must be in the format ``<namespace>.<collection>``.
"""

galaxy_type = context.CLIARGS['type']
Expand Down Expand Up @@ -569,7 +572,9 @@ def execute_info(self):

def execute_install(self):
"""
uses the args list of roles to be installed, unless -f was specified. The list of roles
Install one or more roles(``ansible-galaxy role install``), or one or more collections(``ansible-galaxy collection install``).
You can pass in a list (roles or collections) or use the file
option listed below (these are mutually exclusive). If you pass in a list, it
can be a name (which will be downloaded via the galaxy API and github), or it can be a local tar archive file.
"""
if context.CLIARGS['type'] == 'collection':
Expand Down Expand Up @@ -819,7 +824,7 @@ def _display_role(gr):

def execute_publish(self):
"""
Publish a collection into Ansible Galaxy.
Publish a collection into Ansible Galaxy. Requires the path to the collection tarball to publish.
"""
api_key = context.CLIARGS['api_key'] or GalaxyToken().get()
api_server = context.CLIARGS['api_server']
Expand Down