mirror of
https://github.com/ansible-collections/community.general.git
synced 2024-09-14 20:13:21 +02:00
Remove extra display statements and add docs (#18229)
* Add docs for ansible-galaxy import --role-name option. * Add docs for ansible-galaxy init --container-enabled option.
This commit is contained in:
parent
bd9ca5ef28
commit
dceb2a0393
3 changed files with 33 additions and 5 deletions
|
@ -100,8 +100,9 @@ configured in your *ansible.cfg* file (/etc/ansible/roles if not configured)
|
||||||
INIT
|
INIT
|
||||||
----
|
----
|
||||||
|
|
||||||
The *init* command is used to create an empty role suitable for uploading
|
The *init* command is used to create a new role suitable for uploading
|
||||||
to https://galaxy.ansible.com (or for roles in general).
|
to https://galaxy.ansible.com (or for roles in general). Creates a skeleton
|
||||||
|
directory structure and default files.
|
||||||
|
|
||||||
USAGE
|
USAGE
|
||||||
~~~~~
|
~~~~~
|
||||||
|
@ -124,6 +125,10 @@ working directory.
|
||||||
|
|
||||||
Don't query the galaxy API when creating roles
|
Don't query the galaxy API when creating roles
|
||||||
|
|
||||||
|
*--container-enabled*::
|
||||||
|
|
||||||
|
Initialize the new role with files appropriate for a Container Enabled role.
|
||||||
|
|
||||||
LIST
|
LIST
|
||||||
----
|
----
|
||||||
|
|
||||||
|
@ -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
|
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.
|
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
|
DELETE
|
||||||
------
|
------
|
||||||
|
|
|
@ -198,10 +198,19 @@ The above will create the following directory structure in the current working d
|
||||||
vars/
|
vars/
|
||||||
main.yml
|
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
|
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.
|
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
|
Search for roles
|
||||||
----------------
|
----------------
|
||||||
|
|
||||||
|
@ -350,8 +359,20 @@ By default the command will wait for Galaxy to complete the import process, disp
|
||||||
Import completed
|
Import completed
|
||||||
Status SUCCESS : warnings=0 errors=0
|
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.
|
Use the *--branch* option to import a specific branch. If not specified, the default branch for the repo will be used.
|
||||||
|
|
||||||
|
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
|
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*.
|
by visiting *My Imports*.
|
||||||
|
|
||||||
|
|
|
@ -234,9 +234,7 @@ class GalaxyCLI(CLI):
|
||||||
dest_file = os.path.join(role_path, rel_root, filename)
|
dest_file = os.path.join(role_path, rel_root, filename)
|
||||||
template_env.get_template(src_template).stream(inject_data).dump(dest_file)
|
template_env.get_template(src_template).stream(inject_data).dump(dest_file)
|
||||||
else:
|
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)
|
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))
|
shutil.copyfile(os.path.join(root, f), os.path.join(role_path, f_rel_path))
|
||||||
|
|
||||||
for d in dirs:
|
for d in dirs:
|
||||||
|
|
Loading…
Reference in a new issue