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.

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

Remove extra display statements and add docs #18229

Merged
merged 2 commits into from
Oct 28, 2016
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
13 changes: 11 additions & 2 deletions docs/man/man1/ansible-galaxy.1.asciidoc.in
Original file line number Diff line number Diff line change
Expand Up @@ -100,8 +100,9 @@ configured in your *ansible.cfg* file (/etc/ansible/roles if not configured)
INIT
----

The *init* command is used to create an empty role suitable for uploading
to https://galaxy.ansible.com (or for roles in general).
The *init* command is used to create a new role suitable for uploading
to https://galaxy.ansible.com (or for roles in general). Creates a skeleton
directory structure and default files.

USAGE
~~~~~
Expand All @@ -124,6 +125,10 @@ working directory.

Don't query the galaxy API when creating roles

*--container-enabled*::

Initialize the new role with files appropriate for a Container Enabled role.

LIST
----

Expand Down Expand Up @@ -277,6 +282,10 @@ Provide a specific branch to import. When a branch is not specified the
branch found in meta/main.yml is used. If no branch is specified in
meta/main.yml, the repo's default branch (usually master) is used.

*--role-name*::

Set the name of the role. Otherwise, the name is derived from the
name of the GitHub repository.

DELETE
------
Expand Down
23 changes: 22 additions & 1 deletion docsite/rst/galaxy.rst
Original file line number Diff line number Diff line change
Expand Up @@ -198,10 +198,19 @@ The above will create the following directory structure in the current working d
vars/
main.yml

Force
=====

If a directory matching the name of the role already exists in the current working directory, the init command will result in an error. To ignore the error
use the *--force* option. Force will create the above subdirectories and files, replacing anything that matches.

Container Enabled
=================

If you are creating a Container Enabled role, use the *--container-enabled* option. This will create the same directory structure as above, but populate it
with default files appropriate for a Container Enabled role. For instance, the README.md has a slightly different structure, the *.travis.yml* file tests
the role using [Ansible Container](https://github.com/ansible/ansible-container), and the meta directory includes a *container.yml* file.

Search for roles
----------------

Expand Down Expand Up @@ -350,9 +359,21 @@ By default the command will wait for Galaxy to complete the import process, disp
Import completed
Status SUCCESS : warnings=0 errors=0

Branch
======

Use the *--branch* option to import a specific branch. If not specified, the default branch for the repo will be used.

If the *--no-wait* option is present, the command will not wait for results. Results of the most recent import for any of your roles is available on the Galaxy web site
Role name
=========

By default the name given to the role will be derived from the GitHub repository name. However, you can use the *--role-name
option to override this and set the name.

No wait
=======

If the *--no-wait* option is present, the command will not wait for results. Results of the most recent import for any of your roles is available on the Galaxy web site
by visiting *My Imports*.

Delete a role
Expand Down
2 changes: 0 additions & 2 deletions lib/ansible/cli/galaxy.py
Original file line number Diff line number Diff line change
Expand Up @@ -234,9 +234,7 @@ def execute_init(self):
dest_file = os.path.join(role_path, rel_root, filename)
template_env.get_template(src_template).stream(inject_data).dump(dest_file)
else:
display.display("root: %s f: %s role_skeleton: %s" % (root, f, role_skeleton))
f_rel_path = os.path.relpath(os.path.join(root, f), role_skeleton)
display.display("f_rel_path: %s" % f_rel_path)
shutil.copyfile(os.path.join(root, f), os.path.join(role_path, f_rel_path))

for d in dirs:
Expand Down