internet/community.general
3
0
Fork 0
mirror of https://github.com/ansible-collections/community.general.git synced 2026-05-07 22:02:50 +00:00
Code Issues Packages Projects Releases Wiki Activity

Remove extra display statements and add docs (#18229)

Browse Source 
* Add docs for ansible-galaxy import --role-name option.

* Add docs for ansible-galaxy init --container-enabled option.
This commit is contained in:
Chris Houseknecht
2016-10-28 00:38:39 -04:00
committed by GitHub
parent bd9ca5ef28
commit dceb2a0393
3 changed files with 33 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files

23
docsite/rst/galaxy.rst
View File

@@ -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
----------------
@@ -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