Skip to content

Update role commands in galaxy dev_guide #3372

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

Open
Akasurde wants to merge 1 commit into
base: devel
Choose a base branch
from
Open

Update role commands in galaxy dev_guide #3372

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 6 additions & 6 deletions docs/docsite/rst/galaxy/dev_guide.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -66,9 +66,9 @@ use the ``--force`` option. Force will create the above subdirectories and files
Container enabled
-----------------

If you are creating a Container Enabled role, pass ``--type container`` to ``ansible-galaxy init``. This will create the same directory structure as above, but populate it
with default files appropriate for a Container Enabled role. For example, 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.
If you are creating a Container Enabled role, pass ``--type container`` to ``ansible-galaxy role init``. This will create the same directory structure as above, but populate it
with default files appropriate for a Container Enabled role. For example, 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.

Using a custom role skeleton
----------------------------
Expand All @@ -77,7 +77,7 @@ A custom role skeleton directory can be supplied as follows:

.. code-block:: bash

$ ansible-galaxy init --role-skeleton=/path/to/skeleton role_name
$ ansible-galaxy role init --role-skeleton=/path/to/skeleton role_name

When a skeleton is provided, init will:

Expand Down Expand Up @@ -157,7 +157,7 @@ You can create an integration or connection between a role in Galaxy and `Travis
automatically trigger an import in Galaxy, updating the search index with the latest information about the role.

You create the integration using the ``setup`` command with your API token. You will
also need an account in Travis, and your Travis token. Once you're ready, use the following command to create the integration:
also need an account in Travis, and your Travis token. Once you are ready, use the following command to create the integration:

.. code-block:: bash

Expand All @@ -184,7 +184,7 @@ Use the ``--list`` option to display your Travis integrations:

.. code-block:: bash

$ ansible-galaxy setup --list travis github_user github_repo xxx-travis-token-xxx
$ ansible-galaxy role setup --list travis github_user github_repo xxx-travis-token-xxx


ID Source Repo
Expand Down