ansible/docs/templates/collections_galaxy_meta.rst.j2

81 lines
1.9 KiB
Text
Raw Normal View History

.. _collections_galaxy_meta:
************************************
Collection Galaxy Metadata Structure
************************************
.. important::
This feature is available in Ansible 2.8 as a *Technology Preview* and therefore is not fully supported. It should only be used for testing and should not be deployed in a production environment.
Future Galaxy or Ansible releases may introduce breaking changes.
A key component of an Ansible collection is the ``galaxy.yml`` file placed in the root directory of a collection. This
file contains the metadata of the collection that is used to generate a collection artifact.
Structure
=========
The ``galaxy.yml`` file must contain the following keys in valid YAML:
.. rst-class:: documentation-table
.. list-table::
:header-rows: 1
:widths: auto
* - Key
- Comment
{%- for entry in options %}
* - .. rst-class:: value-name
@{ entry.key }@ |br|
.. rst-class:: value-type
@{ entry.type | documented_type }@ |_|
{% if entry.get('required', False) -%}
.. rst-class:: value-separator
/ |_|
.. rst-class:: value-required
required
{%- endif %}
- {% for desc in entry.description -%}
@{ desc | trim | rst_ify }@
{% endfor -%}
{%- endfor %}
Examples
========
.. code-block:: yaml
namespace: "namespace_name"
name: "collection_name"
version: "1.0.12"
readme: "README.md"
authors:
- "Author1"
- "Author2 (https://author2.example.com)"
- "Author3 <author3@example.com>"
dependencies:
"other_namespace.collection1": ">=1.0.0"
"other_namespace.collection2": ">=2.0.0,<3.0.0"
"anderson55.my_collection": "*" # note: "*" selects the highest version available
license:
- "MIT"
tags:
- demo
- collection
repository: "https://www.github.com/my_org/my_collection"