Skip to content

Commit 074743b

Browse files
add note and link for galaxy.yml details (#2092) (#2115)
(cherry picked from commit 8c244c3) Co-authored-by: Sandra McCann <[email protected]>
1 parent 3c64101 commit 074743b

File tree

1 file changed

+5
-1
lines changed

1 file changed

+5
-1
lines changed

docs/docsite/rst/dev_guide/developing_collections_distributing.rst

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,10 @@ Distributing collections
66

77
A collection is a distribution format for Ansible content. A typical collection contains modules and other plugins that address a set of related use cases. For example, a collection might automate administering a particular database. A collection can also contain roles and playbooks.
88

9+
.. note::
10+
Before distributing your collection, ensure you have updated the `galaxy.yml`
11+
file. See :ref:`collection_structure` for details.
12+
913
To distribute your collection and allow others to use it, you can publish your collection on one or more :term:`distribution server`. Distribution servers include:
1014

1115
================================= ===================================================================
@@ -125,7 +129,7 @@ Building your collection tarball
125129

126130
After configuring one or more distribution servers, build a collection tarball. The collection tarball is the published artifact, the object that you upload and other users download to install your collection. To build a collection tarball:
127131

128-
#. Review the version number in your :file:`galaxy.yml` file. Each time you publish your collection, it must have a new version number. You cannot make changes to existing versions of your collection on a distribution server. If you try to upload the same collection version more than once, the distribution server returns the error ``Code: conflict.collection_exists``. Collections follow semantic versioning rules. For more information on versions, see :ref:`collection_versions`. For more information on the :file:`galaxy.yml` file, see :ref:`collections_galaxy_meta`.
132+
#. Review all settings in your :file:`galaxy.yml` file. See :ref:`collections_galaxy_meta` for details. Ensure you have updated the version number. Each time you publish your collection, it must have a new version number. You cannot make changes to existing versions of your collection on a distribution server. If you try to upload the same collection version more than once, the distribution server returns the error ``Code: conflict.collection_exists``. Collections follow semantic versioning rules. For more information on versions, see :ref:`collection_versions`. For more information on the :file:`galaxy.yml` file, see :ref:`collections_galaxy_meta`.
129133
#. Run ``ansible-galaxy collection build`` from inside the top-level directory of the collection. For example:
130134

131135
.. code-block:: bash

0 commit comments

Comments
 (0)